Introduction

Beyond Presence webhooks provide real-time notifications for call events, allowing you to integrate call data directly into your workflows and systems. You can configure webhooks to receive notifications when calls start, messages are sent, and calls end.

Webhooks can be configured in your Beyond Presence dashboard under the “Webhooks” tab. Simply enter your HTTPS endpoint URL, and the system will automatically validate it before saving.

Security Requirements

HTTPS Only: All webhook URLs must use HTTPS protocol for security.

  • URL Validation: URLs are tested with a live ping before saving
  • 10 Second Timeout: Webhook endpoints must respond within 10 seconds
  • Authentication: Authentication support (HMAC, Bearer tokens) is coming soon

Event Types

Message Events

Sent in real-time when a message is exchanged during a call.

{
  "event_type": "message",
  "call_id": "call_123456",
  "message": {
    "sender": "user",
    "message": "Hello, I need help with my account",
    "sent_at": "2024-01-15T10:30:00Z"
  },
  "call_data": {
    "userName": "John Doe",
    "agentId": "agent_456"
  }
}

Call Ended Events

Sent when a call is completed with full summary and analytics.

{
  "event_type": "call_ended",
  "call_id": "call_123456",
  "evaluation": {
    "topic": "Account Support",
    "user_sentiment": "positive",
    "duration_minutes": 5.5,
    "messages_count": 12
  },
  "messages": [
    {
      "sender": "user",
      "message": "Hello, I need help with my account",
      "sent_at": "2024-01-15T10:30:00Z"
    }
  ],
  "user_name": "John Doe"
}

Common Use Cases

Real-time Notifications

Send Slack/Discord notifications for new messages

Data Integration

Store call data in your CRM (Salesforce, HubSpot)

Workflow Automation

Create follow-up tasks based on call outcomes

Analytics

Update live dashboards with call activity

Best Practices

  • Respond Quickly: Process webhooks within 10 seconds
  • Return 200 Status: Always return 200 status for successful webhook calls
  • Validate Data: Check event_type to handle different event formats
  • Monitor Webhooks: Set up alerts if your webhook endpoint goes down

Learn More

Support

Need help setting up webhooks or have questions about the data format?

Join our Slack community for support and discussions. Our community is here to help with webhook implementation, troubleshooting, and best practices!