Xentral icon

Xentral

Interact with Xentral ERP API

Actions196

Webhook → Create

AI-generated

Summary

Create a webhook in Xentral with a specified name, destination URL, secret signature key, and the list of event IDs to subscribe to.

Inputs

  • Name (required) — Specify the name of the webhook to identify it within Xentral.
  • URL (required) — Provide the URL where the webhook events will be sent.
  • Signature Key (required) — Enter a secret key used for HMAC signature verification to ensure webhook payload authenticity.
  • Event IDs (required) — List the event IDs, comma-separated, in their fully qualified format (e.g., "com.xentral.salesOrder.created.v1, com.xentral.customer.updated.v1"), to subscribe the webhook to specific events.

Output shape

a single record

Returns the created webhook object containing details such as assigned ID and configuration. Errors will be reported according to standard Xentral API error handling.

Examples

Example 1: Create a webhook named 'OrderCreatedWebhook' that sends events to https://example\.com/webhook and uses 'secretkey123' as the signature key, subscribing to the event 'com.xentral.salesOrder.created.v1'.

Set 'Name' to 'OrderCreatedWebhook'. Set 'URL' to 'https://example.com/webhook'. Enter 'secretkey123' as the 'Signature Key'. Provide 'com.xentral.salesOrder.created.v1' in the 'Event IDs' field.

Links

Discussion