api-test.md

api.test

Tests passing and receiving arguments and errors from the Slack API.

Official documentation	https://api.slack.com/methods/api.test
Payload class	ApiTestPayload
PayloadResponse class	ApiTestPayloadResponse

Usage

$apiClient = new ApiClient('your-slack-token-here');
$payload   = new ApiTestPayload();
$payload->addArgument('foo', 'bar');
// or...
// $payload->setError('your-error-to-test-here');

$response  = $apiClient->send($payload);

if ($response->isOk()) {
    $response->getArgument('foo'); // outputs 'bar'
} else {
    // normally, this would indicate something went wrong
    // but with this method you actually test the errors you pass to them

    echo $response->getError(); // outputs 'your-error-to-test-here'
}