Get webhooks | Smallest AI Docs

from smallest_ai import SmallestAI
client = SmallestAI(
    token="YOUR_TOKEN_HERE",
)
client.atoms.webhooks.get_webhooks()

{
  "status": true,
  "data": {
    "_id": "string",
    "url": "string",
    "description": "string",
    "status": "enabled",
    "organizationId": "string",
    "createdBy": "string",
    "subscriptions": [
      {
        "_id": "string",
        "webhookId": "string",
        "agentId": {
          "_id": "string",
          "name": "string",
          "description": "string"
        },
        "eventType": "pre-conversation",
        "createdAt": "2024-01-15T09:30:00Z",
        "updatedAt": "2024-01-15T09:30:00Z"
      }
    ],
    "decryptedSecretKey": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z"
  }
}

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

Response

Successful response

statusboolean

dataobject or list of objects

Errors

401

Unauthorized Error

500

Internal Server Error