Skip to main content
POST
Create Subscription

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request to create a new webhook subscription.

agent_id
integer
required
provider
enum<string>
default:microsoft_outlook
Available options:
microsoft_outlook,
google_gmail
resource
string
default:me/mailFolders('Inbox')/messages
change_type
string
default:created
agent_message_template
string | null

Response

Successful Response

Response after creating a subscription.

id
integer
required
provider
string
required
subscription_id
string | null
required
resource
string
required
change_type
string
required
agent_id
integer
required
agent_message_template
string | null
required
status
string
required
expiration_datetime
string | null
required
created_at
string | null
required