Webhooks
Webhooks
Webhooks allow you to receive real-time notifications when events occur in your Popp AI account.
Overview
When certain events happen (e.g., a conversation is completed, a meeting is scheduled), Popp AI sends an HTTP POST request to your specified endpoint with details about the event.
Getting Started
To set up webhooks for your organization, contact our support team at [email protected].
You will receive:
- A Webhook URL configuration for your endpoints
- A Signing Secret for verifying webhook authenticity
Event Categories
We support webhooks for three main categories:
Conversation Events
Track the lifecycle of candidate conversations.
| Event | Description |
|---|---|
CONVERSATION_QUEUED | Conversation is queued and waiting to start |
CONVERSATION_STARTED | Conversation has started with the candidate |
CONVERSATION_COMPLETED | Conversation completed successfully |
CONVERSATION_NEEDS_REVIEW | Conversation requires manual review |
CONVERSATION_OPTED_OUT | Candidate opted out of the conversation |
START_CONVERSATION_FAILED | Failed to start the conversation |
Analysis Events
Get notified when candidate analysis is complete.
| Event | Description |
|---|---|
ANALYSIS_CREATED | A new analysis batch has been created |
CANDIDATE_ANALYSIS_COMPLETED | Analysis for a candidate is complete |
Scheduling Events
Track calendar and meeting activities.
| Event | Description |
|---|---|
CALENDAR_MEETING_SCHEDULED | A meeting has been scheduled |
CALENDAR_MEETING_CANCELLED | A meeting has been cancelled |
CALENDAR_MEETING_RESCHEDULED | A meeting has been rescheduled |
CALENDAR_AVAILABILITY_NOT_FOUND | No available time slots found |
CALENDAR_NOTE_TAKER_COMPLETED | Meeting notes are ready |
Documentation
- Webhook Event Structure - Understand the payload format
- Webhook Authentication - Secure your webhook endpoints
Updated about 1 month ago