Skip to main content
POST
Register a new webhook subscription to receive real-time HTTP POST notifications. Each subscription generates a cryptographically secure secret used to verify webhook signatures.

Authentication

This endpoint requires Bearer token authentication.

Input parameters

The following parameters are accepted in the JSON request body.
string
required
Bearer token for authentication. Format: Bearer <token>.
string
required
Your server’s HTTPS callback URL. Must begin with http:// or https://. Example: https://example.com/api/webhooks/sayvy.
string[]
required
Array of event topics to subscribe to. Must contain at least one valid event name (e.g. ["call.completed", "message.received", "campaign.completed"]).

Response Fields

string
Generated UUID identifier of the webhook subscription.
string
UUID of the organization owning the subscription.
string
Configured callback URL.
string
HMAC SHA-256 signing secret key used to verify the X-Sayvy-Signature header.
string[]
Array of subscribed event types.
boolean
Operational state of the subscription (initially true).
string
ISO 8601 creation timestamp.
string
ISO 8601 modification timestamp.


Previous
List webhooks
GET /api/v1/webhooks
Next