SSoftLinkSMSDocs
Webhooks

Retrieve a webhook event

GET
/api/v1/webhook-events/{event_id}

Authorization

apiKeyAuth
headerX-Api-Key<token>

Your API key, sent as X-Api-Key. Format bsk_<key_id>.<secret>. Create one in the dashboard under Settings → Developer tools.

Path Parameters

event_id*string

Response Body

application/json
  1. response
id*string
object*string
type*string
  • sms.delivered - SMS delivered
  • sms.failed - SMS failed
  • email.delivered - Email delivered
  • email.bounced - Email bounced
  • email.failed - Email failed
  • webhook.test - Test event
Value in"sms.delivered""sms.failed""email.delivered""email.bounced""email.failed""webhook.test"
status*string
  • pending - Pending
  • delivered - Delivered
  • failed - Failed
Value in"pending""delivered""failed"
url*string
Formaturi
Lengthlength <= 500
attempts?integer
Range0 <= value <= 32767
last_status_code?|
Range0 <= value <= 32767
last_error?string
Lengthlength <= 300
last_attempt_at?|
Formatdate-time
next_attempt_at?|
Formatdate-time
delivered_at?|
Formatdate-time
created_at*string
Formatdate-time
payload*unknown
Example Request
curl -X GET 'https://api.softlinksms.co.ke/api/v1/webhook-events/string'
Example Response
{  "id": "evt_6a1f0c2e9b8d4f3aa1c27e5d9b0f4e21",  "type": "sms.delivered",  "created_at": "2026-10-19T08:15:02Z",  "account_id": 1042,  "data": {    "object": "sms",    "id": "3fae8b8e-9c3a-4e9a-9d3a-7e8e9c3a4e9a",    "recipient": "+254712345678",    "status": "delivered",    "traffic_class": "transactional",    "sender_id": "ACMEBANK",    "batch_id": "1c9d7f2a-55e3-4b8e-9a61-0f2d3c4b5a69",    "price": "0.50",    "currency": "KES",    "delivery_description": "DeliveredToTerminal",    "delivered_at": "2026-10-19T08:15:01Z",    "created_at": "2026-10-19T08:15:00Z"  }}

List webhook events GET

Previous Page

Redeliver a webhook event POST

Next Page