Endpoint

POST https://sms.phones.inc/v1/webhooks

Overview

Register a webhook URL. Every new inbound message is delivered to it as a signed message.received event — see the Webhooks guide for the event payload, signature verification, and retry semantics.

Request Body

url
string
required
The destination URL. Must start with http:// or https://.
secret
string
Secret used to HMAC-sign deliveries. If omitted, a random secret is generated and returned.

Response

Returns 201 Created.
ok
boolean
true on success.
id
string
Webhook ID — use it to delete the webhook later.
url
string
The registered URL.
secret
string
The signing secret. Returned only once — store it now; it is needed to verify the X-BlueBubble-Signature header on deliveries.
curl -X POST https://sms.phones.inc/v1/webhooks \
  -H "API-KEY: sk_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com/hooks/imessage"}'
{
  "ok": true,
  "id": "5e4d3c2b-1a09-8765-4321-0fedcba98765",
  "url": "https://example.com/hooks/imessage",
  "secret": "f3a9c2e8b1d4076a5c3e9f2b8d1a4c7e0b5d8f2a6c9e3b7d1f4a8c2e6b0d5f9a"
}