Skip to main content
POST
/
api_webhooks
Create API webhook
curl --request POST \
  --url https://api.heyy.io/api/v2.0/api_webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "tenantId": "<string>",
  "type": "WHATSAPP_MESSAGE_RECEIVED",
  "url": "<string>",
  "channelId": "<string>"
}'
{
  "data": {
    "id": "<string>",
    "type": "<string>",
    "url": "<string>",
    "isActive": true,
    "channelId": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
tenantId
string
required
​
type
enum<string>
required
Available options:
WHATSAPP_MESSAGE_RECEIVED,
WHATSAPP_MESSAGE_STATUS,
SMS_MESSAGE_RECEIVED,
SMS_MESSAGE_STATUS,
EMAIL_MESSAGE_RECEIVED,
EMAIL_MESSAGE_STATUS,
INSTAGRAM_MESSAGE_RECEIVED,
INSTAGRAM_MESSAGE_STATUS,
INSTAGRAM_MESSAGE_ECHO
​
url
string
required
​
channelId
string

Response

200 - application/json
​
data
object
required