Skip to main content
POST
/
v2
/
organizations
/
{orgId}
/
teams
/
{teamId}
/
workflows
Create organization team workflow for event-types
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",
      "type": "event-type",
      "activation": {
        "isActiveOnAllEventTypes": false,
        "activeOnEventTypeIds": [
          698191,
          698192
        ]
      },
      "trigger": {
        "type": "beforeEvent"
      },
      "steps": [
        {
          "id": 67244,
          "stepNumber": 1,
          "recipient": "const",
          "template": "reminder",
          "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}."
          },
          "action": "email_host",
          "email": "[email protected]",
          "phone": "<string>",
          "phoneRequired": true,
          "includeCalendarEvent": true
        }
      ],
      "userId": 2313,
      "teamId": 4214321,
      "createdAt": "2024-05-12T10:00:00.000Z",
      "updatedAt": "2024-05-12T11:30:00.000Z"
    }
  ]
}

Headers

​
Authorization
string

For non-platform customers - value must be Bearer <token> where <token> is api key prefixed with cal_

​
x-cal-secret-key
string

For platform customers - OAuth client secret key

​
x-cal-client-id
string

For platform customers - OAuth client ID

Path Parameters

​
teamId
number
required
​
orgId
number
required

Body

application/json
​
name
string
required

Name of the workflow

Example:

"Platform Test Workflow"

​
activation
object
required

Activation settings for the workflow

​
trigger
object
required

Trigger configuration for the event-type workflow, allowed triggers are beforeEvent,eventCancelled,newEvent,afterEvent,rescheduleEvent,afterHostsCalVideoNoShow,afterGuestsCalVideoNoShow,bookingRejected,bookingRequested,bookingPaymentInitiated,bookingPaid,bookingNoShowUpdated

​
steps
object[]
required

Steps to execute as part of the event-type workflow, allowed steps are email_host,email_attendee,email_address,sms_attendee,sms_number,whatsapp_attendee,whatsapp_number,cal_ai_phone_call

Response

201 - application/json
​
status
enum<string>
required

Indicates the status of the response

Available options:
success,
error
Example:

"success"

​
data
object[]
required

workflow