Webhooks
Overview
Set up a webhook endpoint to receive real-time notifications for the following Velt events:
Setting up a Webhook
To enable Webhooks go to the Configurations -> Webhook Service in the Velt Console, or click here
Webhook Auth Token
- Optional security feature to authenticate webhook requests.
- Set a unique auth token in your Velt console’s webhook settings.
- We add this token to the Authorization header of each request as
Basic YOUR_AUTH_TOKEN
. - Helps you verify that requests are from Velt, not from unauthorized sources.
Endpoint URL
- This is the endpoint that we will send the webhook data to. This is usually hosted on your server.
Payload Encoding
-
Enable Base64 encoding for webhook payloads (disabled by default).
-
Addresses issues with payloads containing HTML tags that may fail due to strict endpoint policies.
-
If enabled, ensure your server can decode Base64 encoded payloads.
-
Example of decoding a Base64 encoded payload:
Payload Encryption
- Enable payload encryption for enhanced security (disabled by default).
- Configure this option in the Velt Console.
- Encryption details:
- Payload encryption: AES-256-CBC
- Key encryption: RSA with PKCS1 OAEP padding and SHA-256 hash
- Public key format:
- Provide only the base64-encoded key string, without PEM headers/footers
- Recommended key size: 2048 bits
- Example of setting up decryption for Node.js:
Was this page helpful?