Skip to main content
Webhooks allow your application to receive real-time updates from Dojah. For example, when a verification is completed, an address check fails, or a document analysis is flagged, a notification is received. This ensures your systems can react instantly to user events.

​
How Webhooks Work

Once you subscribe to a service, Dojah will send an HTTP (usually a POST or a GET) request to your webhook URL whenever the relevant event occurs. Dojah’s request will include details of the event such as the service type and webhook URL. Dojah’s Webhook services allow you to subscribe for webhooks, fetch all subscriptions, and also delete a webhook service.
To start receiving webhooks, make a POST request with the service you want to monitor and the URL where Dojah should send updates. There is also the option of subscribing via the dashboard.
  • Go to Developers > Webhooks
  • Click “Subscribe”
  • Fill in the form:
    • App Name – Select the app you want the webhook tied to
    • Webhook URL – Enter the endpoint where Dojah will send events
    • Service Name – Choose the service (e.g., KYC Widget, NGN Wallet)
To retrieve a list of all active webhook subscriptions:Request Url
  {{baseUrl}}api/v1/webhook/fetch
Authorization
HeaderTypeDescription
AppIdstringCreate an app to get your app ID on dashboard here
Authorizationstringpublic secret key
Response
	{
    "entity": [
      {
        "app_id": "61e6bef823664a003647505f",
        "endpoint": "https://webhook.site/ec43b51e-eca7-42f0-b794-fb4f7b8c89d0",
        "environment": "live",
        "service": "sms",
        "confirmation_status": "DELIVERED",
        "date_created": "2022-01-18T14:31:36.810231+01:00",
        "date_updated": "2022-01-18T14:31:36.810319+01:00"
      },
      {
        "app_id": "61e6bef823664a003647505f",
        "endpoint": "https://webhook.site/ec43b51e-eca7-42f0-b794-fb4f7b8c89d0",
        "environment": "sandbox",
        "service": "sms",
        "confirmation_status": "DELIVERED",
        "date_created": "2022-01-18T14:22:22.398813+01:00",
        "date_updated": "2022-01-18T14:22:22.398857+01:00"
      }
    ]
  }
This endpoint allows you to delete webhooks that no longer serve you. You can either delete via API or easily delete via the dashboard.Request URL
	{{baseUrl}}api/v1/webhook/delete
Authorization
HeaderTypeDescription
AppIdstringCreate an app to get your app ID on dashboard here
Authorizationstringpublic secret key
Body Parameter
ParameterTypeDescriptionRequired
servicestringType of services [ sms, ngn_wallet]yes
Response
{
  "entity": "webhook deleted successfully"
}