POST
/
v1
/
reporting
/
webhook
curl --location 'https://api.sbmg.app/v1/reporting/webhook' \
--header 'x-api-key: YOUR_API_KEY'
--data '{
    "hookUrl": "https://my-webhook.com/inbound/sms"
}'

{
  "hook_id": 234
}

Whenever a new outbound message is received SBMG can send a POST request to your webhook for your services or integrations to process.

​
Body

​
hookUrl
string
required

The URL where events will be sent when inbound SMS messages are received.

curl --location 'https://api.sbmg.app/v1/reporting/webhook' \
--header 'x-api-key: YOUR_API_KEY'
--data '{
    "hookUrl": "https://my-webhook.com/inbound/sms"
}'

​
Response

​
hook_id
array

This is the key to your webhook. Retain this id to dele

{
  "hook_id": 234
}

​
Inbound Recieved Action

When an inbound SMS message is received, the configured webhook(s) will receive a POST request with the following payload:

Response
{
  "account_id": "f123bf12-f23b-345d-bddc-5e6789abb0c",
  "destination_address": "6422999888",
  "direction": "OUTBOUND",
  "content": "Hello world",
  "date": "2023-06-14T09:06:46Z",
  "user_metadata": {
    "myMetdataKey": "value 3"
  }
}