POST /apps/{app_id}/keys

Creates an API key for the application specified.

Servers

Path parameters

Name Type Required Description
app_id String Yes

The application ID.

Request headers

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

Default value: "application/json"

Request body fields

Name Type Required Description
channels String Yes

Specify the channels and queues that this key can be used with.

name String Yes

The name for your API key. This is a friendly name for your reference.

capabilities[] Array Yes

The capabilities that this key has. More information on capabilities can be found in the Ably documentation.

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.