Webhooks

List recent delivery attempts

get/api/v1/customer/webhooks/{id}/deliveries

Request

  • Base URL: https://virtualsms.io
  • URL: https://virtualsms.io/api/v1/customer/webhooks/{id}/deliveries
  • Auth: one of:
    • API key in header X-API-Key
    • API key in query parameter api_key

Path parameters

idstring required

Query parameters

limitinteger

Values above 500 are clamped to 500.

offsetinteger

Response

Deliveries returned, newest first

successboolean
countinteger
limitinteger
offsetinteger

Example response

{
  "deliveries": [
    {
      "event_id": "01JBQ7X4M2K9N3P5R7T9V1W3Y5",
      "event_type": "sms.received",
      "attempt": 1,
      "status": "pending",
      "response_status": 200
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.