v4

OpenAPI 3.0.12026-07-3189233676.2 KB

Webhooks

Update a webhook endpoint

The endpoint updates a webhook.

patch/v1/webhooks/{webhook_id}/

Request body

namestring

Public name for this webhook config.

webhook_urlstring uri

Webhook URL where event data will be sent.

eventsstring[]

List of events sent to this webhook URL.

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

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"
}