ASassinafy
Webhooks

Update webhook subscription

Changed on

Update the account's oldest webhook endpoint (creating it if the account has none) — which events are monitored, whether delivery is enabled, and the delivery/contact details. Accounts with several endpoints should use Update webhook endpoint. Requires the webhooks:write OAuth scope.

Copy as Markdown Open in ChatGPT Open in Claude

put/v1/accounts/{accountId}/webhooks/subscriptions

Request

Path parameters

accountIdstring required

Workspace account ID.

Request body

eventsstring[] required

Event type codes to subscribe to (see GET /v1/webhooks/event-types).

is_activeboolean required

Whether events should be delivered to the webhook.

urlstring uri required

The URL that will receive events: https for a new or changed URL (a URL stored before keeps working). Its host must resolve to a public address (400 otherwise), and redirects are not followed.

emailstring email required

Email that receives important webhook-communication notices.

Example request

{
  "events": [
    "document_ready",
    "document_prepared"
  ],
  "is_active": true,
  "url": "https://example.com?test=1",
  "email": "email@test.com"
}

Response

The updated subscription

statusinteger

HTTP status code, mirrored in the body.

messagestring

Human-readable message; empty on success.

Example response

{
  "status": 200,
  "data": {
    "events": [
      "document_ready",
      "document_prepared"
    ],
    "is_active": true,
    "url": "https://example.com?test=1",
    "email": "email@test.com",
    "updated_at": "2023-05-10T14:58:24Z"
  }
}

Changes

  • 5fcad067d962Revision changes
    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

  • 3672991376b6Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status