Headers
For non-platform customers - value must be Bearer <token>
where <token>
is api key prefixed with cal_
For platform customers - OAuth client secret key
For platform customers - OAuth client ID
Path Parameters
Body
application/json
curl --request POST \
--url https://api.cal.com/v2/organizations/{orgId}/teams/{teamId}/workflows \
--header 'Content-Type: application/json' \
--data '{
"name": "Platform Test Workflow",
"activation": {
"isActiveOnAllEventTypes": false,
"activeOnEventTypeIds": [
698191
]
},
"trigger": {
"offset": {
"value": 24,
"unit": "hour"
},
"type": "beforeEvent"
},
"steps": [
{
"action": "email_address",
"stepNumber": 1,
"recipient": "attendee",
"template": "reminder",
"sender": "<string>",
"verifiedEmailId": "31214",
"includeCalendarEvent": true,
"message": {
"subject": "Reminder: Your Meeting {EVENT_NAME} - {EVENT_DATE_ddd, MMM D, YYYY h:mma} with Cal.com",
"html": "<p>This is a reminder from {ORGANIZER} of {EVENT_NAME} to {ATTENDEE} starting here {LOCATION} {MEETING_URL} at {START_TIME_h:mma} {TIMEZONE}.</p>"
}
}
]
}'
{
"status": "success",
"data": [
{
"id": 101,
"name": "Platform Test Workflow",
"userId": 2313,
"teamId": 4214321,
"activation": {
"isActiveOnAllEventTypes": false,
"activeOnEventTypeIds": [
698191,
698192
]
},
"trigger": {
"type": "beforeEvent",
"offset": {
"value": 24,
"unit": "hour"
}
},
"steps": [
{
"id": 67244,
"stepNumber": 1,
"action": "email_host",
"recipient": "const",
"email": 31214,
"phone": "<string>",
"template": "reminder",
"includeCalendarEvent": true,
"sender": "Cal.com Notifications",
"message": {
"subject": "Reminder: Your Meeting {EVENT_NAME} - {EVENT_DATE_ddd, MMM D, YYYY h:mma} with Cal.com",
"html": "<p>Reminder for {EVENT_NAME}.</p>",
"text": "Reminder for {EVENT_NAME}."
}
}
],
"createdAt": "2024-05-12T10:00:00.000Z",
"updatedAt": "2024-05-12T11:30:00.000Z"
}
]
}
curl --request POST \
--url https://api.cal.com/v2/organizations/{orgId}/teams/{teamId}/workflows \
--header 'Content-Type: application/json' \
--data '{
"name": "Platform Test Workflow",
"activation": {
"isActiveOnAllEventTypes": false,
"activeOnEventTypeIds": [
698191
]
},
"trigger": {
"offset": {
"value": 24,
"unit": "hour"
},
"type": "beforeEvent"
},
"steps": [
{
"action": "email_address",
"stepNumber": 1,
"recipient": "attendee",
"template": "reminder",
"sender": "<string>",
"verifiedEmailId": "31214",
"includeCalendarEvent": true,
"message": {
"subject": "Reminder: Your Meeting {EVENT_NAME} - {EVENT_DATE_ddd, MMM D, YYYY h:mma} with Cal.com",
"html": "<p>This is a reminder from {ORGANIZER} of {EVENT_NAME} to {ATTENDEE} starting here {LOCATION} {MEETING_URL} at {START_TIME_h:mma} {TIMEZONE}.</p>"
}
}
]
}'
{
"status": "success",
"data": [
{
"id": 101,
"name": "Platform Test Workflow",
"userId": 2313,
"teamId": 4214321,
"activation": {
"isActiveOnAllEventTypes": false,
"activeOnEventTypeIds": [
698191,
698192
]
},
"trigger": {
"type": "beforeEvent",
"offset": {
"value": 24,
"unit": "hour"
}
},
"steps": [
{
"id": 67244,
"stepNumber": 1,
"action": "email_host",
"recipient": "const",
"email": 31214,
"phone": "<string>",
"template": "reminder",
"includeCalendarEvent": true,
"sender": "Cal.com Notifications",
"message": {
"subject": "Reminder: Your Meeting {EVENT_NAME} - {EVENT_DATE_ddd, MMM D, YYYY h:mma} with Cal.com",
"html": "<p>Reminder for {EVENT_NAME}.</p>",
"text": "Reminder for {EVENT_NAME}."
}
}
],
"createdAt": "2024-05-12T10:00:00.000Z",
"updatedAt": "2024-05-12T11:30:00.000Z"
}
]
}
For non-platform customers - value must be Bearer <token>
where <token>
is api key prefixed with cal_
For platform customers - OAuth client secret key
For platform customers - OAuth client ID
Name of the workflow
"Platform Test Workflow"
Activation settings for the workflow
Show child attributes
Trigger configuration for the workflow
Show child attributes
Steps to execute as part of the workflow
Show child attributes
Was this page helpful?