How to Configure a Webhook on Arattai Business Platform

How to Configure a Webhook on Arattai Business Platform

Webhooks let Arattai notify your systems when something happens, such as a message being delivered, a customer replying, or a template being approved.


One Webhook per Event Category  

Webhooks are organised by category, and each is configured separately. This means you can point conversation events at one service and billing-relevant delivery events at another.

→ Webhook Event Categories Explained


How to Configure a Webhook  

  1. Go to Developer space and open Webhooks.

  2. Find the category you want and select Configure webhook.

  3. Enter your endpoint URL. It must be: 

    • HTTPS

    • Under 2048 characters

    • Reachable from the internet

  1. Select Verify. Arattai checks that the endpoint is reachable and responds as expected. You cannot continue until it does.

  2. Optionally, generate a shared secret for this webhook so your integration can verify the authenticity of Arattai's payloads.

  3. Select the events you want to receive. At least one is required.

  4. Save the webhook configuration.


NotesNote: The same endpoint URL can be reused across categories.


Shared Secrets  

A webhook configuration provides a Primary and a Secondary secret. Your integration uses them to validate webhook requests, Arattai signs each payload, and your endpoint verifies the signature before acting on it.

You can view and copy each secret, and manage them independently. You can generate a secondary shared secret while rotating the primary, bring the new secret into your systems while the old one is still valid, then retire the old one.


WarningRotating or deleting a secret breaks things immediately. If you regenerate or delete a secret, any application still verifying signatures with the old value starts rejecting Arattai's payloads straight away. Roll the new secret out to your systems first, then change it here. Deleting a secret cannot be undone.


Editing, Pausing and Deleting a Webhook  

Action

What happens

Edit

Reopens the configuration with the endpoint, secrets and events pre-filled. Changing the endpoint means verifying again.

Pause

Turns the webhook off with its toggle. Arattai stops sending events to this endpoint, but the configuration is kept. Turn it back on when you want events again. Use this for maintenance rather than deleting.

Delete

Removes the configuration entirely. Your integration stops receiving these events. This cannot be undone.