Skip to main content
Webhook

List all webhooks

GET/v4/config/platform/webhooks

Lists the webhooks of the organisation (or of the sandbox organisation of the call), the newest first, each with the result of its last delivery. Deleted webhooks are not listed. Use offset and limit to page through the list; an offset below 0 or a limit of 0 or less gets the default.

Each item holds the secret key of the webhook in clear text.

Authorizations

  • Authorizationstringheaderrequired

    Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.

    Scope:webhooks:read

Query parameters

  • offsetinteger

    Number of records to skip for pagination. A negative or unreadable value falls back to 0.

    At least 0.

    Default:0

  • limitinteger

    Maximum number of records to return per page.

    Default:10

Response

application/json

The webhooks on the page and the pagination data.

  • paginationobject

    The position of this page in the list.

  • webhooksobject[]

    The webhooks on this page.