Skip to main content
POST
/
v1
/
accounts
/
{accountId}
/
webhooks
cURL
curl -X POST \
  https://api.sakari.io/v1/accounts/{{ACCOUNT_ID}}/webhooks \
  -H 'Authorization: Bearer {{TOKEN}}' \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "https://requestbin.io",
  "eventTypes": ["message-received"]
}'
{
  "success": true,
  "data": {
    "eventTypes": [
      "message-received"
    ],
    "destination": "<string>",
    "id": "<string>",
    "type": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
accountId
string
required

Account to apply operations to

Body

application/json
​
url
string<uri>
Example:

"https://myserver.com/send/callback/here"

​
eventTypes
enum<string>[]
Available options:
contact-created,
contact-updated,
contact-removed,
message-received,
message-sent,
message-status,
conversation-started,
contact-opt-out,
contact-opt-in,
list-opt-out,
list-opt-in

Response

200 - application/json

successful operation

​
success
boolean
required
​
data
object
required