WorkflowActionTriggeredWebhook
Emitted when a workflow action is triggered.
payload_7RDQF0G5VT8PAV4ERN90B5Q27YWhen the action occurred
2024-01-15T10:30:00Zpayload objectrequired
action object
The action that was triggered
When the workflow action was created
Unique workflow action identifier (opaque ID)
properties objectrequired
Action-specific configuration properties
Action-specific configuration properties
Type of action to execute
Possible values: [send_custom_email, trigger_automation]
event object
The event that triggered the action
Additional event information
attendees object[]required
All event attendees
Attendee display name
John DakerAttendee email address
jdaker@example.comAttendee custom fields
Attendee first name
JohnUnique attendee identifier (opaque ID)
attendee_7RDQF0G5VT8PAV4ERN90B5Q27YIs attendee organizer?
falseAttendee last name
DakerHas attendee opted in to marketing?
falseAttendee phone number
+15555555555Attendee response status
acceptedAttendee time zone
America/New_YorkBuffer time after event in minutes
Buffer time before event in minutes
Reason for cancellation
When the event was canceled
conferencing objectrequired
Video conferencing details
Join instructions
Join URL
Meeting ID
Conferencing type
When the event was created
Event description
description_settings objectrequired
Settings for description generation
Event duration in minutes
Event end time
Unique event identifier (opaque ID)
Whether this is a group session
link objectnullable
Associated scheduling link (preview)
Link ID
Link name
Link slug
Event location description
Location settings
Maximum number of attendees for group session
Additional event metadata
organizer objectnullablerequired
The organizer of the event
Attendee display name
John DakerAttendee email address
jdaker@example.comAttendee custom fields
Attendee first name
JohnUnique attendee identifier (opaque ID)
attendee_7RDQF0G5VT8PAV4ERN90B5Q27YIs attendee organizer?
falseAttendee last name
DakerHas attendee opted in to marketing?
falseAttendee phone number
+15555555555Attendee response status
acceptedAttendee time zone
America/New_YorkOriginal end time (if rescheduled)
Original start time (if rescheduled)
payment objectnullable
Payment information (if applicable)
Total amount of discounts (in cents)
Total amount of shipping (in cents)
Total amount of tax (in cents)
Total amount charged (in cents)
Payment state
Possible values: [awaiting_checkout, paid]
URL to complete payment
Associated poll (if any)
Reason for rescheduling
When the event was rescheduled
scheduler objectnullable
The scheduler of the event
Attendee display name
John DakerAttendee email address
jdaker@example.comAttendee custom fields
Attendee first name
JohnUnique attendee identifier (opaque ID)
attendee_7RDQF0G5VT8PAV4ERN90B5Q27YIs attendee organizer?
falseAttendee last name
DakerHas attendee opted in to marketing?
falseAttendee phone number
+15555555555Attendee response status
acceptedAttendee time zone
America/New_Yorkscope objectnullable
Associated scope/team
Scope ID
Scope name
Scope slug
Event start time
Event state
Possible values: [confirmed, canceled, awaiting_reschedule, awaiting_checkout, checkout_expired, awaiting_approval, declined, tentative]
Event title/summary
Public URL for the event
rule object
The rule that was triggered
actions object[]required
Actions to execute when this rule is triggered
When the workflow action was created
Unique workflow action identifier (opaque ID)
properties objectrequired
Action-specific configuration properties
Action-specific configuration properties
Type of action to execute
Possible values: [send_custom_email, trigger_automation]
When the workflow rule was created
Unique workflow rule identifier (opaque ID)
Amount of time offset for the trigger
Direction of the trigger offset relative to the event
Possible values: [before, after]
Unit of time for the trigger offset
Possible values: [minutes, hours, days]
Type of event that triggers this rule
Possible values: [event_created, event_canceled, event_rescheduled, event_completed]
workflow object
The workflow that was triggered
When the workflow was created
Unique workflow identifier (opaque ID)
Workflow name
Workflow state
Possible values: [active, disabled, draft]
Possible values: [workflow.action.triggered]
2024-01-15{
"id": "payload_7RDQF0G5VT8PAV4ERN90B5Q27Y",
"occurred_at": "2024-01-15T10:30:00Z",
"payload": {
"action": {
"created_at": "2024-01-15T10:30:00Z",
"id": "waction_def456",
"properties": {
"recipient": "attendee",
"subject": "Your meeting is confirmed",
"template": "confirmation"
},
"type": "send_custom_email"
},
"event": {
"additional_info": "Please prepare project overview",
"attendees": [
{
"display_name": "John Doe",
"email": "john@example.com",
"fields": [],
"first_name": "John",
"id": "attendee_123",
"is_organizer": true,
"last_name": "Doe",
"marketing_opt_in": false,
"phone_number": null,
"response_status": "accepted",
"time_zone": "America/New_York"
},
{
"display_name": "Jane Smith",
"email": "jane@example.com",
"fields": [],
"first_name": "Jane",
"id": "attendee_456",
"is_organizer": false,
"last_name": "Smith",
"marketing_opt_in": true,
"phone_number": "+1234567890",
"response_status": "accepted",
"time_zone": "America/New_York"
}
],
"buffer_after": 0,
"buffer_before": 15,
"cancel_reason": null,
"canceled_at": null,
"conferencing": {
"instructions": "Click the link to join",
"join_url": "https://zoom.us/j/123456789",
"meeting_id": "123456789",
"type": "zoom"
},
"created_at": "2024-01-15T10:30:00Z",
"description": "Discussing project requirements",
"description_settings": {
"include_attendees": true,
"include_fields": false,
"include_link_name": true
},
"duration": 30,
"end_at": "2024-01-20T14:30:00Z",
"id": "event_abc123",
"is_group_session": false,
"link": {
"id": "link_abc123",
"name": "30 Minute Meeting",
"slug": "30min"
},
"location": "Zoom meeting",
"location_settings": [
{
"integration_id": "zoom_123",
"type": "zoom"
}
],
"maximum_group_size": 1,
"metadata": {},
"organizer": {
"display_name": "John Doe",
"email": "john@example.com",
"fields": [],
"first_name": "John",
"id": "attendee_123",
"is_organizer": true,
"last_name": "Doe",
"marketing_opt_in": false,
"phone_number": null,
"response_status": "accepted",
"time_zone": "America/New_York"
},
"original_end_at": null,
"original_start_at": null,
"payment": {
"amount_discount": 0,
"amount_shipping": 0,
"amount_tax": 100,
"amount_total": 1000,
"state": "awaiting_checkout",
"url": "https://checkout.stripe.com/xxxxxxxxx"
},
"poll": null,
"reschedule_reason": null,
"rescheduled_at": null,
"scheduler": {
"display_name": "Jane Smith",
"email": "jane@example.com",
"fields": [],
"first_name": "Jane",
"id": "attendee_456",
"is_organizer": false,
"last_name": "Smith",
"marketing_opt_in": true,
"phone_number": "+1234567890",
"response_status": "accepted",
"time_zone": "America/New_York"
},
"scope": {
"id": "scope_xyz789",
"name": "Sales Team",
"slug": "sales"
},
"start_at": "2024-01-20T14:00:00Z",
"state": "confirmed",
"summary": "30 Minute Meeting with John Doe",
"url": "https://savvycal.com/events/event_abc123"
},
"rule": {
"actions": [
{
"created_at": "2024-01-15T10:30:00Z",
"id": "waction_def456",
"properties": {
"recipient": "attendee",
"template": "confirmation"
},
"type": "send_custom_email"
}
],
"created_at": "2024-01-15T10:30:00Z",
"id": "wrule_abc123",
"trigger_offset_amount": 10,
"trigger_offset_direction": "after",
"trigger_offset_unit": "minutes",
"trigger_type": "event_created"
},
"workflow": {
"created_at": "2024-01-15T10:30:00Z",
"id": "workflow_abc123",
"name": "Send confirmation email",
"state": "active"
}
},
"type": "workflow.action.triggered",
"version": "2024-01-15"
}