Webhook and Events

Webhooks & Events lets you manage where Xenith sends webhooks and check what happened to each one. Use it to set up Endpoints and choose their events, review every Event Xenith creates for your account, see why a delivery succeeded or failed, and resend a delivery.

There are three sections under Webhooks & Events in Xenith:

  1. Webhook Signature Secret: a security key used to verify that incoming webhook events truly come from Xenith (authenticity check).

  1. Endpoints: where you set up the Webhook URLs that receive events and choose which events each one gets (the actual delivery channel).

  1. Events: Once your Endpoints are configured, you can view event delivery details and resend deliveries from the Events tab.

Webhook Signature Secret

Xenith secures webhook events by including a signature in each webhook request header. You can use your Webhook Signature Secret to compute and verify this signature, ensuring that incoming events are authentic and originate from Xenith. Learn more here.

View Webhook Secret

If you have the required permissions to access Developer Settings, you can retrieve your Webhook Signature Secret from the dashboard.

To view your secret:

  1. Navigate to Settings → Developer Settings → Webhook Signature Secret
  2. Click "View"
  3. Authenticate using the OTP sent to your registered email
  4. Once authenticated, your Webhook Signature Secret will be displayed
  5. Click "Hide" or navigate away to conceal the secret

Regenerate Webhook Secret

The Secret Regeneration feature allows you to rotate your Webhook Signature Secret directly from the dashboard. You may regenerate your secret in the following scenarios:

  1. Security incident response — If you suspect your secret has been exposed or compromised
  2. Regular security maintenance — As part of your internal security best practices
  3. Team changes — When personnel with access to credentials leave your organisation

To regenerate your secret:

  1. Navigate to Settings → Developer Settings → Webhook Signature Secret
  2. Click "Regenerate"
  3. Authenticate using the OTP sent to your registered email
  4. A new Webhook Signature Secret will be generated and displayed immediately
  5. Update your integration with the new secret to continue verifying incoming webhook events

Important Notes:

  • Irreversible: Once regenerated, the previous webhook secret cannot be restored.
  • Secret rotation: The new webhook secret takes effect immediately upon generation, and the previous secret will no longer be valid.
  • Integration update required: Webhook signature verification may fail until your system is updated with the new secret.
  • Automatic retry: Failed webhook deliveries will be retried using exponential backoff. Learn more here
  • Environment-specific: Regenerating in production does not affect staging, and vice versa.

Endpoints

Endpoints lets you manage where Xenith sends webhooks and check what happened to each one. Use it to set up the Webhook URL and choose their events. Once set up, it will allow you to receive real-time notifications about specific activities.

Set Up An Endpoint

The URL must meet the Webhook Security requirements. You can add up to 10 Endpoints.

  1. Navigate to Settings → Developer Settings → Webhook & Events → Endpoints
  2. Click “+ New Endpoint”
  3. Fill out the form with your preferred label and destination Webhook URL, then select the events you want to receive (multiple selections allowed). A sample payload for the last selected event will appear for reference
  4. Click Save. When those events occur, Xenith will send webhook event payloads to the URL you specified.

Important notes on Setting up an Endpoint:

  • If the callbackURL in your API request differs from the registered Endpoint URL for the same event, both URLs will receive the event. If both URLs are the same, Xenith will send the event only once.
  • Events without a destination will still appear in the Events tab, but without any deliveries.

Monitor and Manage An Endpoint

  1. Success Rate: See the delivery success rate of your endpoint of the last 24 hours and last 7 days.
  2. Edit: You can edit the webhook URL, label, and selected events at any time if needed.
  3. Inactivate/Activate: Change the active status of your registered Endpoints without deleting them.
  4. Delete: Delete your registered Endpoints. Delivery history stays available in Event Details and Event Deliveries.

Important notes on an Inactivated Endpoints:

  • An Inactive Endpoint receives no new deliveries and cannot be resent to.
  • If your callbackURL in any of your API request is the same as an Inactive Endpoint's URL, the callback is still sent once, but it cannot be resent through the Events section.
  • When you make an Endpoint Inactive, waiting retries are cancelled and those deliveries are marked FAILED.
  • Delivery history stays available in Event Details and Event Deliveries.

Event Deliveries

Open an Endpoint to see its Event Deliveries — every delivery to that endpoint, including retries and resends. Deliveries and attempts are listed in time order. A later successful retry or resend does not overwrite earlier records. Each destination is delivered and retried on its own, so one failing Endpoint doesn't affect the others.

  1. Search: Search by Delivery ID (prefix), Event ID (prefix), Transaction ID or Subject ID.
  2. Filter: Filter by Event Type, Delivery Status, Created Date, and Number of Attempts.
  3. Delivery List: Shows Delivery ID, Event ID, Event Type, Delivery Status, and Created Time (in your timezone).
  4. Refresh: Reloads the list and shows when it was last updated.
  5. Delivery Details: Shows the delivery details, including a Click Resend to send the delivery again. For Pay In, Pay Out and Account Inquiry Events, you can only resend the latest Event of a transaction. If the transaction has a newer status, Resend on the older Event is blocked.

Events

The Events tab lists every Event Xenith created for your account, once per Event, whether it was sent to several destinations or to none.

  1. Search: Search evnt by Event ID (prefix), or Transaction ID / Subject ID.
  2. Filter: Filter by Event Type, Created Time.
  3. Refresh: reloads the list and shows when it was last updated.
  4. Events List: Shows Event Type, Event ID, and Created Time (in your timezone, sortable)
  5. Event Details: Shows details of the events, with the delivery summaries, and an action menu with Resend.

KYC webhooks are not shown in Events.

Simulate a Webhook

  1. Navigate to Settings → Developer Settings → Webhook and Events → Endpoints
  2. Click one of your existing Endpoints to open its Details.
  3. Select one of the subscribed events, and review the sample payload displayed on the right.
  4. Click Simulate Webhook to send a test payload to your configured Webhook URL.

Simulate Webhook can only be done in Sandbox Environment


Did this page help you?