Ozow Hub

WebhookRequest

On this page2 sections

Fields

  • endpoint string uri required

    The uri of the webhookWebhook A URL of yours that Ozow calls when something happens, rather than you polling to find out. The call carries no credential of yours and arrives at a public URL, so authenticate it before acting on it: a hash field on the Payments API, a Svix signature on One API. receiver. Must be reachable from the internet. localhost is rejected with a 403, so a local integration needs a tunnel rather than the address the browser uses.

  • eventType string required

    The type of event the webhookWebhook A URL of yours that Ozow calls when something happens, rather than you polling to find out. The call carries no credential of yours and arrives at a public URL, so authenticate it before acting on it: a hash field on the Payments API, a Svix signature on One API. subscribes to.

    values"transaction.complete""refund.complete"
  • messageType string

    Defaults to thin. Specify full to receive a larger payload with as much detail as possible.

    values"thin""full"

Used by