Webhooks

OTP delivery callback from a messaging provider

Unauthenticated; the provider signs nothing, so the X-Callback-Token header must match the provider's callback token. A failed delivery marks the login attempt otp_delivery_failed with the provider's reason; other events are logged.

post/v1/webhooks/otp/{provider}

Request

  • Base URL
    https://api.hify.club
  • Auth
    API key in header X-User-Token

Path parameters

providerstring required
Example:gupshup_whatsapp

Headers

X-Callback-Tokenstring required

Request body

object required

The provider's event payload as it posts it

Response

Event accepted

statusstring

Example response

{
  "status": "ok"
}

Changes

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