Create a webhook

Webhooks are an easy way to receive information about the delivery of your campaign or the replies to your message.

To create a webhook, you just have to log into our platform or simply use the API.

POST

/webhook

Body Parameters

type
required
 The webhook type (MO, DLR, STOP, CLICKER, BALANCE_ALERT)
url
required
 The webhook url
signature You can create a secret signature so we can sign the webhook requests with that secret in the header X-SMSFactor-Signature

Examples


POST /webhook HTTP/1.1
Host: api.smsfactor.com
Authorization: Bearer your.token
Accept: application/json

{
    "webhook":{
        "type": "DLR",
        "url": "https://yourserverurl.com",
        "signature": "mysignature123"
    }
}
          
        

POST /webhook HTTP/1.1
Host: api.smsfactor.com
Authorization: Bearer your.token
Accept: application/xml
<?xml version="1.0" encoding="UTF-8" ?>
<webhook>
  <type>DLR</type>
  <url>https://yourserverurl.com</url>
  <signature>mysignature123</signature>
  <status>live</status>
  <last_http_code>null</last_http_code>
</webhook>
        
      

$response = \SMSFactor\Webhook::create([
  'webhook' => [
    'type' => 'DLR',
    'url' => "https://yourserverurl.com",
    "signature" => "mysignature123"
  ]
]);
$webhook_id = $response->webhook->webhook_id;

Result Format


{
    "status": 1,
    "message": "OK",
    "webhook": {
        "webhook_id": "66",
        "type": "MO",
        "url": "https://yourserverurl.com"
        "signature": "mysignature123"
    }
}
          
        

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <status>1</status>
    <message>OK</message>
    <webhook>
      <webhook_id>66</webhook_id>
      <type>DLR</type>
      <url>https://yourserverurl.com</url>
    </webhook>
</response>