There are two types of webhooks you need to set up and manage in Xenith:

1. Webhook Signature Secret: a security key used to verify that incoming webhook events truly come from Xenith (authenticity check).
2. Webhook: an endpoint configuration where you receive those webhook events (the actual delivery channel).

Webhook Signature Secret

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

If your account has the necessary permissions to access Developer Settings, you can retrieve your Webhook Signature Secret from the Webhook Signature Secret tab in the Developer Settings module.

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, you can view and copy your Webhook Signature Secret
5. Click "Hide" or navigate away to conceal the secret

⚠️

Treat your Webhook Signature Secret like a password. Do not share it, and store it securely. If you suspect it has been compromised, reach out immediately to [email protected]

Webhook

Webhooks allow you to receive real-time notifications about specific activities, such as system maintenance or pay-in credit creation. You can configure webhook endpoints to receive these event payloads and simulate test events during your integration process.

Set Up a Webhook (e.g., for Maintenance Notifications)

1. Navigate to Settings → Developer Settings → Webhook

2. In the Webhooks section, click “+ New Webhook.”

3. Fill out the form by entering your destination Webhook URL and selecting the events you want to receive.

   

4. Click Save. When those events occur, Xenith will send webhook event payloads to the URL you specified.

You can edit the webhook URL, label, and selected events at any time if needed.

Simulate a Webhook

1. Navigate to Settings → Developer Settings → Webhook

2. Click one of your existing webhooks to open its Webhook Details.

3. Review the sample payload displayed on the right.

4. Click Simulate Webhook to send a test payload to your configured Webhook URL.