FOformbricks
Webhooks

Update a webhook

Changed on

Updates specific fields of a webhook endpoint

patch/v1/webhooks/{id}

Request

  • Base URL
    http://localhost:8080
  • URL
    http://localhost:8080/v1/webhooks/{id}
  • Auth
    HTTP bearer

Path parameters

idstring uuid required
Example:018e1234-5678-9abc-def0-123456789abc

Webhook ID (UUID)

Request body

urlstring uri

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

signing_keystring

New signing key. NULL bytes not allowed.

enabledboolean

Enable or disable the webhook

tenant_idstring

Omit to leave unchanged. Empty strings are rejected; webhooks cannot be global. U+FFFD is not allowed (it stands in for invalid UTF-8 or an unpaired surrogate).

event_typesWebhookEventType[]

New list of event types (use empty array to clear). Each value must be one of WebhookEventType, listed at most once.

Example request

{
  "url": "https://example.com/hub-events",
  "signing_key": "whsec_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "tenant_id": "org-123"
}

Response

OK. Returns WebhookPublicData (signing_key omitted).

idstring uuid required

Webhook ID (UUID)

urlstring required

URL that receives webhook POSTs

enabledboolean required

Whether the webhook is active

tenant_idstring

Tenant/organization identifier

event_typesWebhookEventType[]

Event types this webhook subscribes to (empty = all)

created_atstring date-time required

When the webhook was created

updated_atstring date-time required

When the webhook was last updated

disabled_reasonstring nullable

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

disabled_atstring date-time nullable

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

Changes

  • ac72ae0de955Revision changes
    • warning

      changed the pattern of the request property from ^[^\x00]*$ to ^[^\x00\uFFFD]*$

    • info

      added the non-success response with the status

  • 17c77a1a3031Revision changes
    • warning

      added the new content_too_large enum value to the response property for the response status

    • warning

      added the new content_too_large enum value to the response property for the response status

    • warning

      added the new content_too_large enum value to the response property for the response status

    • warning

      added the new content_too_large enum value to the response property for the response status