Esc

↑↓ move↵ openIndex · Pagefind
REST reference · Core Tools

Webhooks

9 endpoints9 implementedAll modules →
  1. GET /rest/v1.0/companies/{company_id}/webhooksList webhook subscriptions
  2. POST /rest/v1.0/companies/{company_id}/webhooksCreate a webhook subscription
  3. GET /rest/v1.0/companies/{company_id}/webhooks/{id}Show a webhook subscription (secret masked; see secret_preview)
  4. PATCH /rest/v1.0/companies/{company_id}/webhooks/{id}Update a webhook subscription
  5. DELETE /rest/v1.0/companies/{company_id}/webhooks/{id}Delete a webhook subscription
  6. GET /rest/v1.0/companies/{company_id}/webhooks/{id}/deliveriesList delivery history (company administrators only)
  7. POST /rest/v1.0/companies/{company_id}/webhooks/{id}/deliveriesQueue an idempotent synthetic webhook.test delivery (company administrators only)
  8. POST /rest/v1.0/companies/{company_id}/webhooks/{id}/deliveries/{delivery_id}/retryRequeue a failed test delivery with its original bytes and identity
  9. POST /rest/v1.0/companies/{company_id}/webhooks/{id}/rotate_secretRotate the signing secret
GET /rest/v1.0/companies/{company_id}/webhooks

List webhook subscriptions

v1.0Implemented

Parameters

  • company_id
    stringpathrequired

Response · 200 · WebhookListItem[]

  • id
    integerrequired
  • company_id
    integerrequired
  • url
    stringrequired
  • events
    string[]required
  • active
    booleanrequired
  • secret_preview
    string
  • created_by_id
    integer
  • created_at
    string
  • updated_at
    string
POST /rest/v1.0/companies/{company_id}/webhooks

Create a webhook subscription

v1.0Implemented

Parameters

  • company_id
    stringpathrequired

Request body

  • webhook
    objectrequired

Response · 201 · Webhook

  • id
    integerrequired
  • company_id
    integerrequired
  • url
    stringrequired
  • events
    string[]required
  • active
    booleanrequired
  • secret
    stringrequired
  • secret_preview
    string
  • created_by_id
    integer
  • created_at
    string
  • updated_at
    string
GET /rest/v1.0/companies/{company_id}/webhooks/{id}

Show a webhook subscription (secret masked; see secret_preview)

v1.0Implemented

Parameters

  • company_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · WebhookListItem

  • id
    integerrequired
  • company_id
    integerrequired
  • url
    stringrequired
  • events
    string[]required
  • active
    booleanrequired
  • secret_preview
    string
  • created_by_id
    integer
  • created_at
    string
  • updated_at
    string
PATCH /rest/v1.0/companies/{company_id}/webhooks/{id}

Update a webhook subscription

v1.0Implemented

Parameters

  • company_id
    stringpathrequired
  • id
    stringpathrequired

Request body

  • webhook
    objectrequired

Response · 200 · WebhookListItem

  • id
    integerrequired
  • company_id
    integerrequired
  • url
    stringrequired
  • events
    string[]required
  • active
    booleanrequired
  • secret_preview
    string
  • created_by_id
    integer
  • created_at
    string
  • updated_at
    string
DELETE /rest/v1.0/companies/{company_id}/webhooks/{id}

Delete a webhook subscription

v1.0Implemented

Parameters

  • company_id
    stringpathrequired
  • id
    stringpathrequired

Response · 204

No response body.

GET /rest/v1.0/companies/{company_id}/webhooks/{id}/deliveries

List delivery history (company administrators only)

v1.0Implemented

Parameters

  • company_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · WebhookDelivery[]

  • id
    string (uuid)required
  • subscriptionId
    integerrequired
  • jobId
    integerrequired
  • outcome
    stringrequired
  • status
    stringrequired
  • attemptCount
    integerrequired
  • httpStatus
    integer
  • errorCode
    string
  • createdAt
    string
  • updatedAt
    string
  • attempts
    object[]required
POST /rest/v1.0/companies/{company_id}/webhooks/{id}/deliveries

Queue an idempotent synthetic webhook.test delivery (company administrators only)

v1.0Implemented

Parameters

  • company_id
    stringpathrequired
  • id
    stringpathrequired

Request body

  • request_key
    stringrequired

Response · 202 · WebhookDelivery

  • id
    string (uuid)required
  • subscriptionId
    integerrequired
  • jobId
    integerrequired
  • outcome
    stringrequired
  • status
    stringrequired
  • attemptCount
    integerrequired
  • httpStatus
    integer
  • errorCode
    string
  • createdAt
    string
  • updatedAt
    string
  • attempts
    object[]required
POST /rest/v1.0/companies/{company_id}/webhooks/{id}/deliveries/{delivery_id}/retry

Requeue a failed test delivery with its original bytes and identity

v1.0Implemented

Parameters

  • company_id
    stringpathrequired
  • id
    stringpathrequired
  • delivery_id
    stringpathrequired

Response · 202 · WebhookDelivery

  • id
    string (uuid)required
  • subscriptionId
    integerrequired
  • jobId
    integerrequired
  • outcome
    stringrequired
  • status
    stringrequired
  • attemptCount
    integerrequired
  • httpStatus
    integer
  • errorCode
    string
  • createdAt
    string
  • updatedAt
    string
  • attempts
    object[]required
POST /rest/v1.0/companies/{company_id}/webhooks/{id}/rotate_secret

Rotate the signing secret

v1.0Implemented

Parameters

  • company_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · Webhook

  • id
    integerrequired
  • company_id
    integerrequired
  • url
    stringrequired
  • events
    string[]required
  • active
    booleanrequired
  • secret
    stringrequired
  • secret_preview
    string
  • created_by_id
    integer
  • created_at
    string
  • updated_at
    string

Ask the OS

Reading this page

Ask anything about this page. Answers use what you're reading as context.

Suggested

    AI · may be imperfect · sample data where shown

    Open file