Webhooks

List your webhook endpoints

get/api/v1/customer/webhooks

Request

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

Response

Endpoints returned (never includes the signing secret)

successboolean
countinteger

Example response

{
  "webhooks": [
    {
      "id": "7",
      "url": "https://your-server.com/virtualsms-events",
      "description": "production events",
      "events": [
        "sms.received",
        "order.expired"
      ],
      "active": true,
      "threshold": 5,
      "last_error_code": "500",
      "secret": "whsec_a3f8b2c1d4e5f6a7b8c9d0e1f2a3b4c5"
    }
  ]
}

Changes

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