Skip to main content
POST
Create an event subscription

Authorizations

Authorization
string
header
required

Authorization: Bearer hmok_... API key or a dashboard session token

Path Parameters

ch
string
required

ch_ channel id

Pattern: ^ch_[A-Za-z0-9]{8}$

Body

application/json
url
string<uri>
required

Public https URL that receives the events

events
enum<string>[]
required
Minimum array length: 1
Available options:
whatsapp.message.received,
whatsapp.message.status,
instagram.message.received,
instagram.comment.received
label
string | null

Shown in your delivery log

Maximum string length: 120

Response

Created. secret is returned only here.

subscriptionId
string
required
Pattern: ^sub_[A-Za-z0-9]{8}$
url
string<uri>
required
events
enum<string>[]
required
Available options:
whatsapp.message.received,
whatsapp.message.status,
instagram.message.received,
instagram.comment.received
label
string | null
required
secret
string
required

Signs X-HookMyApp-Signature-256 on every delivery. Returned only here.

createdAt
string<date-time>
required