v1

latestOpenAPI 3.0.12026-07-141671231.8 MB

Hidden

Create a webhook subscription

Creates a webhook subscription to receive real-time notifications for events occurring within your company or companies.

Authentication & Scope

Developer Token: The subscription is scoped to the single company linked to the token.
OAuth Application Access Token: The subscription covers all companies accessible by the OAuth application.

Limits Up to 10 webhook subscriptions are allowed per subscriber.

Secret . The secret will be auto-generated.

🔒 The secret is only returned in the creation response and cannot be retrieved afterwards. Make sure to store it securely.

post/api/external/v2/webhook_subscriptions

Request body

callback_urlstring uri required

HTTPS URL where webhook events will be sent

eventsstring[] required

Array of event types to subscribe to.

customer_invoice.e_invoicing_status_updated: the event is triggered when a customer invoice e-invoicing status is updated.
dms_file.created: the event is triggered when a dms file is created.

enabledboolean

Indicates whether the webhook subscription is active

Example request

{
  "callback_url": "https://example.com/webhooks",
  "events": [
    "dms_file.created",
    "customer_invoice.e_invoicing_status_updated"
  ]
}

Response

Renders the created webhook subscription

idinteger required

ID of the webhook subscription

callback_urlstring uri required

HTTPS URL where webhook events are sent

eventsstring[] required

Array of event types to subscribe to.

customer_invoice.e_invoicing_status_updated: the event is triggered when a customer invoice e-invoicing status is updated.
dms_file.created: the event is triggered when a dms file is created.

enabledboolean required

Indicates whether the webhook subscription is active

secretstring required

Automatically generated secret for HMAC signature verification. This is only returned once on creation. Store it securely as it cannot be retrieved afterwards.

created_atstring date-time required

Creation date of the webhook subscription

updated_atstring date-time required

Last update date of the webhook subscription

Example response

{
  "id": 12345,
  "callback_url": "https://example.com/webhooks",
  "events": [
    "dms_file.created",
    "customer_invoice.e_invoicing_status_updated"
  ],
  "enabled": true,
  "created_at": "2023-08-07T14:23:12.000Z",
  "updated_at": "2023-08-07T14:23:12.000Z"
}