api.test.md

Checks API calling code.

Facts

| Method URL: | https://slack.com/api/api.test | | Preferred HTTP method: | POST | | Accepted content types: | application/x-www-form-urlencoded, application/json | | Rate limiting: | Tier 4 | | Works with: |

Token type	Required scope(s)

|

---

This method helps you test your calling code.

You can also use this method as a very basic way to test whether Slack's Web API is functioning. Learn more.

You can't use this method with a Sign in with Slack token.

Arguments

Argument	Example	Required	Description
error	my_error	Optional	Error response to return
foo	bar	Optional	example property to return

This method supports application/json via HTTP POST. Present your token in your request's Authorization header. Learn more.

Response

Standard success response

{
    "ok": true
}

Artificial parameter echoing response by passing foo=bar

{
    "ok": true,
    "args": {
        "foo": "bar"
    }
}

Artificial error response

{
    "ok": false,
    "error": "my_error",
    "args": {
        "error": "my_error"
    }
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing. Callers should always check the value of the ok params in the response.

Error	Description
invalid_arguments	The method was called with invalid arguments.
invalid_arg_name	The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.
invalid_charset	The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8 iso-8859-1.
invalid_form_data	The method was called via a POST request with Content-Type application/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.
invalid_post_type	The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/json application/x-www-form-urlencoded multipart/form-data text/plain.
missing_post_type	The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.
team_added_to_org	The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.
request_timeout	The method was called via a POST request, but the POST data was either missing or truncated.
fatal_error	The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.

Warnings

This table lists the expected warnings that this method will return. However, other warnings can be returned in the case where the service is experiencing unexpected trouble.

Warning	Description
missing_charset	The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.
superfluous_charset	The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous.