List Webhooks

GET

/v0/webhooks

GET

/v0/webhooks

1 from agentmail import AgentMail
2 client = AgentMail(api_key="YOUR_API_KEY", )
3 client.webhooks.list()

200Retrieved

1 {
2   "count": 1,
3   "webhooks": [
4     {
5       "webhook_id": "webhook_id",
6       "url": "url",
7       "secret": "secret",
8       "created_at": "2024-01-15T09:30:00Z",
9       "events": [
10         "message.received",
11         "message.received"
12       ],
13       "inboxes": [
14         "inboxes",
15         "inboxes"
16       ]
17     },
18     {
19       "webhook_id": "webhook_id",
20       "url": "url",
21       "secret": "secret",
22       "created_at": "2024-01-15T09:30:00Z",
23       "events": [
24         "message.received",
25         "message.received"
26       ],
27       "inboxes": [
28         "inboxes",
29         "inboxes"
30       ]
31     }
32   ],
33   "limit": 1,
34   "last_key": "last_key"
35 }

Query parameters

limitintegerOptional

Limit of number of items returned.

last_keystringOptional

Key of last item.

Response

This endpoint returns an object.

countinteger

Number of items returned.

webhookslist of objects

Webhook items. Ordered by created_at ascending.

limitintegerOptional

Limit of number of items returned.

last_keystringOptional

Key of last item.