Watch Meetings Settings
List meeting settings endpoint is in charge of the meetings features configuration in the Salesloft application. You can track whether a user in a team enabled the External Calendar in their account by periodically checking this endpoint for updates.
We expect integrations to do the following after External Calendar connection is enabled for a user:
- Start Initial Calendar Sync via API when a user changes their calendar type to external.
- Begin monitoring user calendar updates and pushing those updates via the Salesloft API to keep Salesloft up to date.
- Begin watching for Salesloft-created meetings and adding them to a user's calendar as they appear.
Integration must stop sending updates for a user if their calendar type was changed from external.
POST /v2/meetings/settings/searches
Request:
- Headers:
- Authorization: Bearer <api_key>
- Url Params: No specific query parameters needed.
- Body:
{
# you can filter specific calendar type, in case you want to fetch users who enabled integration
"calendar_type": "external",
# user_guid filter allows you to check meetings settings for one or multiple users in the team
"user_guids": [
"00000000-0000-0000-0000-000000000000"
],
# for periodical checks you can use updated_at filter to skip results that were not changed since your last request
"updated_at": {
"gt": "2022-10-20T00:00:00.000000Z"
}
}
Response:
- Status: 200
- Body:
{
"data": [
{
"id": 1,
"calendar_type": "external",
"email_address": "pam.beesly@example.com",
# `primary_calendar_id` will be used later to associate events with specific user
"primary_calendar_id": "external_00000000-0000-0000-0000-000000000000",
"primary_calendar_name": "Pam Beesly",
"created_at": "2018-10-23T18:45:24.888022Z",
"updated_at": "2022-10-21T09:44:15.328045Z",
"primary_calendar_connection_failed": false,
"user": {
"_href": "https://api.salesloft.com/v2/users/00000000-0000-0000-0000-000000000000",
"id": "00000000-0000-0000-0000-000000000000"
},
# other fileds are described in the API docs, and irrelevant for the integration
...
}
],
"metadata": {
"filtering": {
"calendar_type": "external",
"updated_at": {
"gt": "2022-10-20T00:00:00.000000Z"
}
},
"paging": {
"current_page": 1,
"next_page": null,
"per_page": 100,
"prev_page": null
}
}
}