API · Webhooks

List Webhooks

List webhooks for your team (requires full access).

GET/webhooksFull access

Request parameters

Parameter	Type	Description
`limit` query · optional	`integer` 1–100 Default: 20	Maximum number of webhooks to return.
`after` query · optional	`string`	Webhook ID for the next page, exclusive with before.
`before` query · optional	`string`	Webhook ID for the previous page, exclusive with after.

Request example

Set OPENSEND_BASE_URL=https://api.example.com and OPENSEND_API_KEY=os_replace_me on your server.

bash

curl -X GET "$OPENSEND_BASE_URL/webhooks" \
  -H "Authorization: Bearer $OPENSEND_API_KEY"

Response

200 · application/json. Example IDs stand for IDs returned by your installation.

json

{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "id": "479e3145-dd38-476b-932c-529ceb705947",
      "endpoint": "https://webhook.example.com/handler",
      "events": [
        "email.sent"
      ],
      "status": "enabled",
      "created_at": "2023-10-06 23:47:56.678+00"
    }
  ]
}

Behavior and errors

Each team can register up to 100 webhooks. List responses omit signing secrets; retrieve one webhook to read its secret.

Use a full-access credential. Unknown or foreign resources return 404. See authentication, errors, rate limits, and pagination.