List webhooks

List webhooks. View request and response details for this Samva email API endpoint.

GET
/v1/webhooks

Returns the organization's webhook endpoints, oldest first, with each endpoint's delivery counts, optionally filtered by a search term matched against name and URL, and by status. Pass nextCursor back as cursor for the next page; it is null on the last page.

x-api-key<token>

In: header

Query Parameters

limit?string|null
cursor?CursorEncoded|null
search?string|null
status?|null

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/webhooks"
{  "items": [    {      "id": "string",      "name": "string",      "url": "string",      "eventTypes": [        "message.sent"      ],      "channels": [        "email"      ],      "mailboxIds": [        "string"      ],      "namespaceId": "string",      "status": "active",      "hasCustomHeaders": true,      "failureStartedAt": "string",      "lastSucceededAt": "string",      "createdAt": "string",      "updatedAt": "string",      "deliveries": {        "total": 0,        "pending": 0,        "delivered": 0,        "exhausted": 0,        "cancelled": 0      }    }  ],  "nextCursor": "string"}

Related documentation