Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.trysiren.io/llms.txt

Use this file to discover all available pages before exploring further.

Webhooks in Siren enable real-time communication between your application and external services by sending HTTP callbacks when specific events occur. Siren supports two types of webhooks: Notification Webhook and Inbound Message Webhook.

​
Accessing Webhook Configuration

To configure webhooks in Siren:
1
Navigate to Settings in the left navigation pane
2
Click on Configurations under Settings
3
Select the Webhook tab

​
Notification Webhook

Notification Webhooks allow you to receive real-time updates about notification events in your Siren account.

​
Configuration Steps

  • Webhook URL: The endpoint URL where Siren will send notification events
  • Header Key: The header key to be used in the webhook request
  • Header Value: The header value to be used in the webhook request
  • Verification Key: The verification key to be used in the webhook request

​
Notification Webhook Payload

Notification webhooks follow this structure: 
{
  "event": "notification_event_type",
  "timestamp": "2023-01-01T00:00:00Z",
  "data": {
    // Notification event data
  }
}
For a complete list of notification events and their payloads, see the Notification Webhook API Reference.

​
Inbound Message Webhook

Inbound Message Webhooks allow external services to send messages to your Siren account, enabling two-way communication.

​
Configuration Steps

  • Webhook URL: The endpoint URL where Siren will recieve notification events
  • Header Key: The header key to be used in the webhook request
  • Header Value: The header value to be used in the webhook request
  • Verification Key: The verification key to be used in the webhook request

​
Inbound Message Webhook Payload

Inbound message webhooks use this structure: 
{
  "event": "message_received",
  "timestamp": "2023-01-01T00:00:00Z",
  "data": {
    // Inbound message data
  }
}
For detailed information about inbound message formats and handling, refer to the Inbound Webhook API Reference.