Skip to main content
GET
/
webhooks
List all webhooks for the team
curl --request GET \
  --url https://api.lettermint.co/v1/webhooks \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "route_id": "<string>",
      "name": "<string>",
      "url": "<string>",
      "events": [
        "message.created"
      ],
      "enabled": true,
      "last_called_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "path": "<string>",
  "per_page": 1,
  "next_cursor": "<string>",
  "next_page_url": "<string>",
  "prev_cursor": "<string>",
  "prev_page_url": "<string>"
}

Authorizations

​
Authorization
string
header
required

Team API token. Find this in your team settings.

Query Parameters

​
sort
string
default:-created_at

Available sorts are name, url, created_at. You can sort by multiple options by separating them with a comma. To sort in descending order, use - sign in front of the sort, for example: -name.

​
filter[enabled]
boolean

Filter by enabled status

​
filter[event]
enum<string>

Filter by specific event type

Available options:
message.created,
message.sent,
message.delivered,
message.hard_bounced,
message.soft_bounced,
message.spam_complaint,
message.failed,
message.suppressed,
message.unsubscribed,
message.opened,
message.clicked,
message.inbound,
message.policy_rejected,
webhook.test
​
filter[route_id]
string

Filter by route ID

​
filter[search]
string

Search by webhook name or URL

Response

200 - application/json

Paginated set of WebhookListData

​
data
WebhookListData · object[]
required
​
path
string | null
required

Base path for paginator generated URLs.

​
per_page
integer
required

Number of items shown per page.

Required range: x >= 0
​
next_cursor
string | null
required

The "cursor" that points to the next set of items.

​
next_page_url
string<uri> | null
required
​
prev_cursor
string | null
required

The "cursor" that points to the previous set of items.

​
prev_page_url
string<uri> | null
required