Webhooks

Update a webhook endpoint

patch/api/v1/customer/webhooks/{id}

Request

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

Path parameters

idstring required

Request body

urlstring uri
descriptionstring nullable
eventsstring[]
thresholdnumber float nullable
activeboolean
pausedboolean

Response

Updated

successboolean

Example response

{
  "webhook": {
    "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.