webhooks

Create a webhook endpoint

Registers a public HTTPS URL (at most 20 per account). The response contains the signing secret — shown only once. The endpoint stays pending_verification until it answers our signed webhook.verification event with a 2xx status. Not available with the public sandbox key.

post/webhook_endpoints

Request

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

Request body

urlstring uri required
eventsWebhookEvent[] required

Response

Endpoint created; secret is shown only this once.

object'webhook_endpoint' required
idstring required
urlstring uri required
eventsWebhookEvent[] required
status'pending_verification' | 'active' | 'disabled' required
livemodeboolean

Mode of the key that created the endpoint. Test keys see and manage only test endpoints, live keys only live endpoints; test-mode events are delivered only to test endpoints and live events only to live endpoints.

created_atstring date-time required
secretstring required

Signing secret: the base64 part after whsec_ is the HMAC key.

Changes

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