FOformbricks
Webhooks

Get a webhook by ID

Changed on

Retrieves a single webhook endpoint by its UUID. signing_key is omitted for security.

get/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)

Response

OK

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

  • 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

  • d2fa5d9f2e98Revision changes
    • warning

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

    • warning

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

    • warning

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