This documentation is currently under development. Certain sections are not yet complete and will be added shortly.
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Webhooks (Configure)

Create and edit webhooks from the admin console.

Configure webhooks

The admin console provides a self-service way to create and manage webhooks. No API integration is required.

Create a webhook

Open Settings → General → Webhooks. Create a webhook, then complete the required fields.

  • Description identifies the webhook in the console.

  • Endpoint is the HTTPS URL that receives webhook requests.

  • Events defines which events trigger delivery.

The console generates an ID and a Secret automatically. The Secret is the HMAC signing key for webhook requests.

Edit a webhook

Open Settings → General → Webhooks, then select the webhook to edit. Update its Description, Endpoint, or Events fields and save the changes.

Confirm that the Endpoint is reachable over HTTPS. Confirm that the selected Events match the required integration flow.

Validate the setup

Store the Secret in the receiving system before enabling production processing. Use it to validate the x-neostore-signature header on every request.

For event payloads and signature validation, see Webhooks.

FAQ

Is API access required to create a webhook?

No. Webhooks can be created and managed from the admin console.

Can the Secret be retrieved later?

No. Copy and store the Secret when the webhook is created. The console does not show the full value again.

Last updated