Custom API Action
Make a custom, authenticated HTTP call to the Slack API.
This action is unlike other Slack cards. Refer to the Slack API documentation.
Options
| Field | Definition | Type | Required |
|---|---|---|---|
|
Request Type |
Dropdown |
TRUE |
|
|
GET |
Retrieves data from a web server based on your parameters. This method requests a representation of the specified resource. If a request is successful, you receive a 200 (OK) response message with the requested content. |
||
|
POST |
Sends data to a web server based on your parameters (for example, uploading a file). Multiple POST requests may result in a different outcome than a single POST, so you should be cautious about unintentionally sending multiple POST requests. If a request is successful, you receive a 200 (OK) response message. |
||
|
PUT |
Sends data to be stored at a specific location on a web server based on your parameters (for example, uploading a file). The difference between PUT and POST requests is that PUT is idempotent. This means that for successful requests, the result of a single PUT request is the same as many identical PUT requests. If a request is successful, you receive a 200 (OK), 201 (Created), or 204 (No Content) response message. |
||
|
PATCH |
Applies partial modifications to a resource on a web server based on your parameters. PATCH isn't idempotent, which means that multiple PATCH requests could have unintended consequences. If a PATCH is successful, you receive a 200 (OK) or 204 (No Content) response message. |
||
|
DELETE |
Deletes the specified resource from the web server based on your parameters (if the resource exists). If a DELETE is successful, you receive a 200 (OK) response message. |
Input
| Field | Definition | Type | Required |
|---|---|---|---|
|
Relative URL |
The URL address of the web server that you're attempting to call. Specify the relative URL as /{insert_remaining_URL}. You can specify query parameters in the relative URL using "?", or specify the query parameters as an object key pair in the Query input. For example, https://api.slack.com/scim{{input.Request.Relative URL}}. The Slack Admin connector can only query the SCIM endpoint within Slack, and it can't be used for any other admin APIs within Slack. For such use cases, use the Slack connector. |
Text |
TRUE |
|
Query |
JSON object that determines the action taken at the URL. |
Object or String |
FALSE |
|
Headers |
JSON object that determines the content type of the request. |
Object |
FALSE |
Output
| Field | Definition | Type |
|---|---|---|
|
Status Code |
Result of the operation. The connector returns an HTTP status code that indicates whether the action taken by the card succeeded or failed. For example:
For a full list of possible status codes, see HTTP status codes. |
Number |
|
Headers |
A detailed context for the status code, unrelated to the output body. Response headers depend on your selected HTTP request option. Not all headers are response headers. |
Object |
|
Body |
Data returned from your selected HTTP request (for example, the data from a GET request). |
Object |