Skip to main content
POST
/
webhooks
Create a webhook
curl --request POST \
  --url https://api.arnio.co/api/v1/webhooks \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data @- <<EOF
{
  "companyName": "Company name of webhook",
  "url": "Endpoint of webhook",
  "eventTypes": "Event types to listen for webhook e.g. ['new-message', 'updated-message']",
  "phoneNumber": "Assigned phone number"
}
EOF
{
  "success": true,
  "message": "Webhook created successfully",
  "data": {
    "id": "webhook-123",
    "companyName": "My Company",
    "url": "https://example.com/webhooks",
    "eventTypes": [
      "new-message",
      "update-message"
    ]
  }
}
Create a new webhook to listen events from Arnio.

Authorizations

​
X-API-Key
string
header
required

Provide your generated API Key.

Body

application/json
​
companyName
string
required
Example:

"Company name of webhook"

​
url
string
required
Example:

"Endpoint of webhook"

​
eventTypes
array
required
Example:

"Event types to listen for webhook e.g. ['new-message', 'updated-message']"

​
phoneNumber
string
required
Example:

"Assigned phone number"

Response

200 - application/json

Webhook created successfully