Webhooks

Register a webhook subscription

Registers an HTTPS URL to receive event deliveries. The response includes the HMAC-SHA256 signing_secret once - store it securely; it cannot be retrieved again. Use it to verify the X-VoidMob-Signature header on every inbound delivery.

event_types accepts the literal "*" for all events, or any subset of the typed enum. Max 20 endpoints per user.

post/webhook_endpoints

Request

  • Base URL: https://dashboard.voidmob.com/api/v1
  • URL: https://dashboard.voidmob.com/api/v1/webhook_endpoints
  • Auth: HTTP bearer

Request body

urlstring uri required
event_typesWebhookEventType[]

Response

Endpoint registered. signing_secret is included exactly once.

successtrue required

Example response

{
  "data": {
    "endpoint": {
      "id": "whep_01HXYZ123ABC",
      "signing_secret": "whsec_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
    }
  }
}

Changes

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