Webhooks API | ActiWAPI

Subscribe to real-time events delivered to your HTTPS endpoints.

GET/api/webhooks/events

List event types

Public list of webhook event types you can subscribe to.

URL: https://api.actiwapi.com/api/webhooks/events

Auth: None

Code examples

curl -X GET "https://api.actiwapi.com/api/webhooks/events" \
  -H "Content-Type: application/json"

Response example200

{
  "success": true,
  "data": [
    "message.received",
    "message.sent",
    "session.connected",
    "session.disconnected",
    "campaign.completed"
  ]
}

Try in Swagger UI

GET/api/webhooks

List webhooks

List configured webhook endpoints.

URL: https://api.actiwapi.com/api/webhooks

Auth: JWT Bearer

Headers

Header	Value	Required
Authorization	Bearer {accessToken}	Yes
Content-Type	application/json	Yes*

Code examples

curl -X GET "https://api.actiwapi.com/api/webhooks" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {accessToken}"

Response example200

{
  "success": true,
  "data": [{
    "id": "uuid",
    "url": "https://api.yourapp.com/webhooks/actiwapi",
    "events": ["message.received"],
    "isActive": true
  }]
}

Try in Swagger UI

POST/api/webhooks

Create webhook

URL: https://api.actiwapi.com/api/webhooks

Auth: JWT Bearer

Headers

Header	Value	Required
Authorization	Bearer {accessToken}	Yes
Content-Type	application/json	Yes*

Request example

{
  "url": "https://api.yourapp.com/webhooks/actiwapi",
  "events": ["message.received", "session.disconnected"],
  "secret": "your-signing-secret"
}

Code examples

curl -X POST "https://api.actiwapi.com/api/webhooks" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {accessToken}"
  -d '{  "url": "https://api.yourapp.com/webhooks/actiwapi",  "events": ["message.received", "session.disconnected"],  "secret": "your-signing-secret"}'

Response example201

{ "success": true, "data": { "id": "uuid", "isActive": true } }

Try in Swagger UI

GET/api/webhooks/{id}/history

Delivery history

View delivery attempts and HTTP response codes.

URL: https://api.actiwapi.com/api/webhooks/{id}/history

Auth: JWT Bearer

Headers

Header	Value	Required
Authorization	Bearer {accessToken}	Yes
Content-Type	application/json	Yes*

Path parameters

id — Webhook UUID

Code examples

curl -X GET "https://api.actiwapi.com/api/webhooks/{id}/history" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {accessToken}"

Response example200

{
  "success": true,
  "data": [{
    "event": "message.received",
    "statusCode": 200,
    "deliveredAt": "2026-05-30T10:00:00.000Z"
  }]
}

Try in Swagger UI

Error codes

Failed requests return a JSON envelope with success: false and a human-readable message.

{
  "success": false,
  "message": "Validation failed",
  "errors": {
    "phone": "Valid phone number is required"
  }
}

HTTP	Code	Description
400	VALIDATION_ERROR	Request body or query failed validation.
401	UNAUTHORIZED	Missing or invalid JWT / API key.
403	FORBIDDEN	Authenticated but lacking permission or entitlement.
403	SUBSCRIPTION_INACTIVE	Trial expired or subscription not active.
403	LIMIT_EXCEEDED	Plan limit reached (sessions, messages, API requests, etc.).
404	NOT_FOUND	Resource does not exist or is not in your tenant.
409	CONFLICT	Duplicate resource or invalid state transition.
429	RATE_LIMITED	Too many requests; retry after backoff.
500	INTERNAL_ERROR	Unexpected server error.
502	WHATSAPP_UNAVAILABLE	WhatsApp session disconnected or provider error.

← Back to Getting Started