v1

latestOpenAPI 3.0.32026-08-0422127127.8 KB

Webhook

Get a webhook by ID

get/v2/webhook/{id}

Path parameters

idstring uuid required

Unique ID of the webhook

Response

A single webhook

idstring required

Unique identifier for the webhook.

namestring required

Name of the webhook.

urlstring uri required

URL (https) that accepts JSON encoded POST requests.

rate_limitinteger required

Rate limit for the webhook in requests per second.

is_sandboxboolean required

Deprecated. Will be removed in a future version.

created_atstring date-time required

Timestamp when the webhook was created.

updated_atstring date-time required

Timestamp when the webhook was last updated.

Example response

{
  "id": "67e3e4af-62e8-4515-8b67-6f20d0c51ffb",
  "filter": {
    "event_type": [
      "SMS_STATUS",
      "SMS_INBOUND"
    ],
    "sender": [
      "+61412345678",
      "+61487654321"
    ],
    "status": [
      "DELIVERED",
      "FAILED"
    ],
    "message_ref": [
      "ref123",
      "ref456"
    ],
    "campaign_id": [
      "campaign_123",
      "campaign_456"
    ]
  },
  "name": "Hook",
  "url": "https://webhook.site/uuid",
  "rate_limit": 10,
  "created_at": "2025-04-14T00:59:32.75819Z",
  "updated_at": "2025-04-14T00:59:32.75819Z"
}