Update a webhook

PATCH/v1/webhooks/{id}

Updates specific fields of a webhook endpoint

Path ParametersExpand Collapse

id: string

formatuuid

Body ParametersExpand Collapse

enabled: optional boolean

Enable or disable the webhook

event_types: optional array of "feedback_record.created" or "feedback_record.updated" or "feedback_record.deleted" or 3 more

New list of event types (use empty array to clear). Each value must be one of WebhookEventType.

Accepts one of the following:

"feedback_record.created"

"feedback_record.updated"

"feedback_record.deleted"

"webhook.created"

"webhook.updated"

"webhook.deleted"

signing_key: optional string

New signing key. NULL bytes not allowed.

minLength1

maxLength255

tenant_id: optional string

Omit or send null to leave unchanged. Send empty string to clear (store as null).

maxLength255

url: optional string

New webhook URL. Must be an HTTP or HTTPS URL. NULL bytes not allowed.

minLength1

maxLength2048

formaturi

ReturnsExpand Collapse

id: string

Webhook ID (UUID)

formatuuid

created_at: string

When the webhook was created

formatdate-time

enabled: boolean

Whether the webhook is active

updated_at: string

When the webhook was last updated

formatdate-time

url: string

URL that receives webhook POSTs

disabled_at: optional string

Read-only. When the webhook was disabled. Omitted when null.

formatdate-time

disabled_reason: optional string

Read-only. Set by the system when the webhook was disabled. Omitted when null.

event_types: optional array of "feedback_record.created" or "feedback_record.updated" or "feedback_record.deleted" or 3 more

Event types this webhook subscribes to (empty = all)

Accepts one of the following:

"feedback_record.created"

"feedback_record.updated"

"feedback_record.deleted"

"webhook.created"

"webhook.updated"

"webhook.deleted"

tenant_id: optional string

Tenant/organization identifier

Update a webhook

curl http://localhost:8080/v1/webhooks/$ID \
    -X PATCH \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $HUB_API_KEY" \
    -d '{
          "signing_key": "whsec_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
          "tenant_id": "org-123",
          "url": "https://example.com/hub-events"
        }'

{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "created_at": "2019-12-27T18:11:19.117Z",
  "enabled": true,
  "updated_at": "2019-12-27T18:11:19.117Z",
  "url": "url",
  "disabled_at": "2019-12-27T18:11:19.117Z",
  "disabled_reason": "disabled_reason",
  "event_types": [
    "feedback_record.created"
  ],
  "tenant_id": "tenant_id"
}

Returns Examples

{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "created_at": "2019-12-27T18:11:19.117Z",
  "enabled": true,
  "updated_at": "2019-12-27T18:11:19.117Z",
  "url": "url",
  "disabled_at": "2019-12-27T18:11:19.117Z",
  "disabled_reason": "disabled_reason",
  "event_types": [
    "feedback_record.created"
  ],
  "tenant_id": "tenant_id"
}