Skip to main content

List webhook endpoints

POST 
/api/v1/webhooks/list-endpoints

Returns a paginated list of all webhook endpoints belonging to the authenticated tenant.

The following access conditions are preserved as declared intent and are not implemented by generated code: Tenant request context, Tenant-scoped webhook ownership.

Use this in a guide: Recover a missing backend update · Receive a completed order summary in your backend

Request​

Responses​

Endpoints listed successfully

List endpoints in the authenticated scope with default paging.​

Section ID: DOC-IN-webhooks-api-listWebhookEndpoints#example-webhooks-listWebhookEndpoints-request

Request example

{}

Guide request for Save the signing secret. Replace example resource identifiers with your own authorized values.​

Section ID: DOC-IN-webhooks-api-listWebhookEndpoints#example-cookbook-integrations-webhooks-endpoints-02-request

Request example

{
  "page": 1,
  "perPage": 25
}

Illustrative response shape; omitted default fields and actual outcomes depend on the operation.​

Section ID: DOC-IN-webhooks-api-listWebhookEndpoints#example-webhooks-listWebhookEndpoints-response

Response example

{
  "endpoints": [
    {
      "id": "example_123",
      "name": "example",
      "url": "https://example.com/resource",
      "description": "example",
      "status": "ENDPOINT_STATUS_ACTIVE",
      "secret": "example",
      "httpTimeout": 1,
      "rateLimit": 1,
      "rateLimitDuration": "example",
      "createdAt": "2026-09-16T12:00:00Z",
      "updatedAt": "2026-09-16T12:00:00Z"
    }
  ],
  "pagination": {
    "total": 1,
    "page": 1,
    "perPage": 1,
    "totalPages": 1
  }
}

Document ID: DOC-IN-webhooks-api-listWebhookEndpoints. Section identities and revisions.

SectionStable reference
List webhook endpointsDOC-IN-webhooks-api-listWebhookEndpoints#overview
RequestDOC-IN-webhooks-api-listWebhookEndpoints#request
ResponsesDOC-IN-webhooks-api-listWebhookEndpoints#responses