Passer au contenu principal
POST
/
v1
/
api
/
webhooks
Create Webhook
curl --request POST \
  --url https://api.withallo.com/v1/api/webhooks \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "allo_number": "+1234567890",
  "url": "https://example.com/webhooks/allo",
  "topics": [
    "CALL_RECEIVED",
    "SMS_RECEIVED"
  ],
  "enabled": true
}
'
{
  "data": {
    "id": "web-2NfDKEm9sF8xK3pQr1Zt",
    "alloNumber": "+1234567890",
    "enabled": true,
    "url": "https://example.com/webhooks/allo",
    "topics": [
      "CALL_RECEIVED",
      "SMS_RECEIVED"
    ]
  }
}

Autorisations

​
Authorization
string
header
requis

Scope needed: WEBHOOKS_READ_WRITE

Corps

application/json

Request body for creating a webhook configuration

​
allo_number
string
requis

The Allo phone number to create the webhook for (E.164 format)

Exemple:

"+1234567890"

​
url
string<uri>
requis

The webhook URL endpoint to receive events

​
topics
enum<string>[]
requis

List of webhook topics to subscribe to

Options disponibles:
PING,
CALL_RECEIVED,
SMS_RECEIVED,
SMS_SENT
​
enabled
boolean
défaut:true

Whether the webhook is enabled

Réponse

Webhook created successfully

Response containing the created webhook configuration

​
data
object