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.

EventDescription
CONVERSATION_QUEUEDConversation is queued and waiting to start
CONVERSATION_STARTEDConversation has started with the candidate
CONVERSATION_COMPLETEDConversation completed successfully
CONVERSATION_NEEDS_REVIEWConversation requires manual review
CONVERSATION_OPTED_OUTCandidate opted out of the conversation
START_CONVERSATION_FAILEDFailed to start the conversation

View Conversation Events →

Analysis Events

Get notified when candidate analysis is complete.

EventDescription
ANALYSIS_CREATEDA new analysis batch has been created
CANDIDATE_ANALYSIS_COMPLETEDAnalysis for a candidate is complete

View Analysis Events →

Scheduling Events

Track calendar and meeting activities.

EventDescription
CALENDAR_MEETING_SCHEDULEDA meeting has been scheduled
CALENDAR_MEETING_CANCELLEDA meeting has been cancelled
CALENDAR_MEETING_RESCHEDULEDA meeting has been rescheduled
CALENDAR_AVAILABILITY_NOT_FOUNDNo available time slots found
CALENDAR_NOTE_TAKER_COMPLETEDMeeting notes are ready

View Scheduling Events →

Documentation