Get webhooks

GET

https://api.smallest.ai/atoms/v1/webhook

GET

/atoms/v1/webhook

1 from smallestai import SmallestAI
2 
3 client = SmallestAI(
4     token="YOUR_TOKEN_HERE",
5 )
6 
7 client.atoms.webhooks.get_webhooks()

1 {
2   "status": true,
3   "data": {
4     "_id": "string",
5     "url": "string",
6     "description": "string",
7     "status": "enabled",
8     "organizationId": "string",
9     "createdBy": "string",
10     "subscriptions": [
11       {
12         "_id": "string",
13         "webhookId": "string",
14         "agentId": {
15           "_id": "string",
16           "name": "string",
17           "description": "string"
18         },
19         "eventType": "pre-conversation",
20         "createdAt": "2024-01-15T09:30:00Z",
21         "updatedAt": "2024-01-15T09:30:00Z"
22       }
23     ],
24     "decryptedSecretKey": "string",
25     "createdAt": "2024-01-15T09:30:00Z",
26     "updatedAt": "2024-01-15T09:30:00Z"
27   }
28 }

Retrieve all webhooks for the organization or a specific webhook by ID

Authentication

AuthorizationBearer

API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth.

Query parameters

webhookIdstringOptional

Optional MongoDB ObjectId (24-char hex) of a specific webhook to retrieve. If omitted, returns all webhooks for the organization.

Response

Successful response

statusboolean

dataobject or list of objects

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error