Sign in
Webhooks

Create a webhook endpoint

The endpoint creates a webhook.

post/v1/webhooks/

Request body

namestring required

Public name for this webhook config.

webhook_urlstring uri required

Webhook URL where event data will be sent.

eventsstring[]

List of events sent to this webhook URL.

env_type'sandbox' | 'dev' | 'prod' required

Type of environment.

enabledboolean

Whether the webhook is active.

Example request

{
  "webhook_url": "http://example.com/",
  "events": [
    "task-status-updated",
    "order-status-updated"
  ],
  "env_type": "dev"
}

Response

idstring required

Unique identifier of the webhook.

namestring required

Public name for this webhook config.

webhook_urlstring uri required

Webhook URL where event data will be sent.

eventsstring[] required

List of events sent to this webhook URL.

env_type'sandbox' | 'dev' | 'prod' required

Type of environment.

enabledboolean required

Whether the webhook is active.

created_atstring date-time required

Timestamp when the webhook was created.

updated_atstring date-time required

Timestamp when the webhook was updated last time.

Example response

{
  "id": "48427a36d43c4d5aa6324bc06c692456",
  "webhook_url": "http://example.com/",
  "events": [
    "task-status-updated",
    "order-status-updated"
  ],
  "env_type": "dev",
  "created_at": "2022-05-04T11:30:00Z",
  "updated_at": "2022-05-04T12:00:00Z"
}

Changes

Changed in 2 of the 11 revisions of this API.33

  • 16345eb8097011See the full diff
    • ●

      added the new order-batch-completed enum value to the events/items/ response property for the response status 201

      response-property-enum-value-added

    • ○

      added the new order-batch-completed enum value to the request property events/items/

      request-property-enum-value-added

  • e58688835e2522See the full diff
    • ●

      added the new certification-completed enum value to the events/items/ response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new order-finalized enum value to the events/items/ response property for the response status 201

      response-property-enum-value-added

    • ○

      added the new certification-completed enum value to the request property events/items/

      request-property-enum-value-added

    • ○

      added the new order-finalized enum value to the request property events/items/

      request-property-enum-value-added