SSoftLinkSMSDocs
Webhooks

List webhook events

GET
/api/v1/webhook-events

Every event generated for the account in the last 30 days, newest first, with its delivery status and attempts. Use it to debug your endpoint or to catch up after downtime.

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.

Query Parameters

cursor?string

Pagination cursor from next.

status?string

Delivery status.

Value in"delivered""failed""pending"
type?string

Event type.

Value in"email.bounced""email.delivered""email.failed""sms.delivered""sms.failed""webhook.test"

Response Body

application/json
  1. response
[index: integer]?
Example Request
curl -X GET 'https://api.softlinksms.co.ke/api/v1/webhook-events'
Example Response
[  {    "id": "string",    "object": "string",    "type": "sms.delivered",    "status": "pending",    "url": "http://example.com",    "attempts": 0,    "last_status_code": 0,    "last_error": "string",    "last_attempt_at": "2019-08-24T14:15:22Z",    "next_attempt_at": "2019-08-24T14:15:22Z",    "delivered_at": "2019-08-24T14:15:22Z",    "created_at": "2019-08-24T14:15:22Z",    "payload": null  }]