Skip to main content
GET
cURL

Authorizations

X-Auth-ID
string
header
required

Your Vobiz account Auth ID (MA_XXXXXXXX).

X-Auth-Token
string
header
required

Your Vobiz account Auth Token.

Response

object[] | null

Your subscriptions, or null when there are none.

id
string<uuid>

Unique identifier of the subscription (UUID). Use it with GET, PUT and DELETE /webhooks/{id}.

Example:

"8d4f2a6b-3e1c-4b9a-a7d2-5c8e1f0b6a93"

accountId
string

Auth ID of the account that owns the subscription, for example MA_XXXXXXXX.

Example:

"MA_XXXXXXXX"

url
string<uri>

The URL that receives POST deliveries.

Example:

"https://example.com/vobiz/webhooks"

secret
string

The signing secret for X-Webhook-Signature, returned in clear. Keep it out of logs and client-side code.

Example:

"YOUR_WEBHOOK_SECRET"

events
enum<string>[]

Event names delivered to this URL. An event is delivered only when its name appears here exactly.

A messaging event name you can subscribe to: message.status (delivery state changed), message.delivered (reached the handset), message.failed (could not be delivered), message.received (inbound message) or broadcast.updated (broadcast status or counters changed).

Available options:
message.status,
message.delivered,
message.failed,
message.received,
broadcast.updated
Example:
active
boolean

true when deliveries are on. New subscriptions start true; set it with PUT /webhooks/{id}.

Example:

true

createdAt
string<date-time>

When the subscription was created (ISO 8601). Read it from GET /webhooks/{id} or GET /webhooks.

Example:

"2026-10-18T07:22:11Z"