POST /calls.add

Registers a new Call.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/x-www-form-urlencoded"

token String Yes

Authentication token. Requires scope: calls:write

Request body fields

Name Type Required Description
created_by String No

The valid Slack user ID of the user who created this Call. When this method is called with a user token, the created_by field is optional and defaults to the authed user of the token. Otherwise, the field is required.

external_unique_id String Yes

An ID supplied by the 3rd-party Call provider. It must be unique across all Calls from that service.

date_start Integer No

Call start time in UTC UNIX timestamp format

external_display_id String No

An optional, human-readable ID supplied by the 3rd-party Call provider. If supplied, this ID will be displayed in the Call object.

join_url String Yes

The URL required for a client to join the Call.

desktop_app_join_url String No

When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL.

title String No

The name of the Call.

users String No

The list of users to register as participants in the Call. Read more on how to specify users here.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.