FOformbricks
Webhooks

List webhooks

Changed on

Lists webhook endpoints with optional filters and pagination

get/v1/webhooks

Request

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

Query parameters

enabledboolean
Example:true

Filter by enabled status

tenant_idstring
Example:org-123

Filter by tenant ID. NULL bytes not allowed.

limitinteger

Number of results to return (max 1000)

cursorstring

Omit for the first page. For the next page, use the exact value from the previous response's next_cursor. Opaque (base64-encoded); keyset pagination.

Response

OK. Returns ListWebhooksOutputBody (items omit signing_key).

totalinteger

Total count matching filters (present when offset-based; omitted when using cursor)

limitinteger required

Limit used in query

offsetinteger

Offset used in query (present when offset-based; omitted when using cursor)

next_cursorstring

Opaque cursor for the next page (keyset paging). Present only when there may be more results. Use as the cursor query param for the next page.

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

  • 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