Set up a webhook server to generate a callback URL that receives event notifications from Tavus API.
callback_url
is provided in the POST /conversations
, callbacks will provide insight into the conversation’s state. These can be system-related (e.g. replica joins and room shutdowns) or application-related (e.g. final transcription parsing and recording-ready webhooks). Additional webhooks coming soon.
properties
object.
max_call_duration reached
participant_left_timeout reached
participant_absent_timeout reached
bot_could_not_join_meeting_it_was_probably_ended
daily_room_has_been_deleted
exception_encountered_during_conversation_startup
end_conversation_endpoint_hit
internal error occurred at step x
raven-0
specified in the Perception Layer.callback_url
is provided in the POST /replicas
call, you will receive a callback on replica training completion or on replica training error.
callback_url
is providing in the POST /videos
call, you will receive callbacks on video generation completed and on video error.
Step 1: Install Python Dependencies
Step 2: Make a Webhook Server
server.py
.Step 3: Run the Server
5000
.Step 4: Forward the Port Using Ngrok
ngrok.exe
, then use Ngrok to forward the port.Step 5: Use the Callback URL
/webhook
to the forwarding link and setting it in the callback_url
field.<api_key>
with your actual API key. You can generate one in the Developer Portal.<replica_id>
with the Replica ID you want to use.<persona_id>
with the Persona ID you want to use.