List Webhooks

GET

/v0/webhooks

GET

/v0/webhooks

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

200Retrieved

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

webhookslist of objects

Webhook items. Ordered by created_at ascending.

countinteger

Number of items returned.

limitintegerOptional

Limit of number of items returned.

last_keystringOptional

Key of last item.