API Call Examples

Example commands (*) that you can use to validate proxy behavior against the Slack Discovery APIs. Follow the steps and change the values to match your configuration when needed.

For AWS, change the role to assume with one with sufficient permissions to call the proxy (-r flag). Example:

node tools/psoxy-test/cli-call.js -u [your_psoxy_url]/api/discovery.enterprise.info -r arn:aws:iam::PROJECT_ID:role/ROLE_NAME

If any call appears to fail, repeat it using the -v flag.

(*) All commands assume that you are at the root path of the Psoxy project.

Read workspaces

node tools/psoxy-test/cli-call.js -u [your_psoxy_url]/api/discovery.enterprise.info

Read Users in Grid

node tools/psoxy-test/cli-call.js -u [your_psoxy_url]/api/discovery.users.list?include_deleted=true

Read Conversations in Workspace (any kind, public and private)

1. Get a workspace ID (accessor path in response .enterprise.teams[0].id):

node tools/psoxy-test/cli-call.js -u [your_psoxy_url]/api/discovery.enterprise.info?limit=1

1. Get conversation details of that workspace (replace workspace_id with the corresponding value):

node tools/psoxy-test/cli-call.js -u [your_psoxy_url]/api/discovery.conversations.list?team=[workspace_id]&limit=10

Read Messages in Workspace Channel

1. Get a channel ID (accessor path in response .channels[0].id):

node tools/psoxy-test/cli-call.js -u [your_psoxy_url]/api/discovery.conversations.list?team=[workspace_id]&limit=10

1. Get DM information (no workspace):

node tools/psoxy-test/cli-call.js -u [your_psoxy_url]/api/discovery.conversations.list?limit=10

1. Read messages for workspace channel:1

node tools/psoxy-test/cli-call.js -u [your_psoxy_url]/api/discovery.conversations.history?team=[workspace_id]&channel=[channel_id]&limit=10

1. Omit the workspace ID if channel is a DM

node tools/psoxy-test/cli-call.js -u [your_psoxy_url]/api/discovery.conversations.history?channel=[channel_id]&limit=10

Workspace Channel Info

node tools/psoxy-test/cli-call.js -u [your_psoxy_url]/api/discovery.conversations.info?team=[workspace_id]&channel=[channel_id]&limit=1

Omit the workspace ID if channel is a DM

node tools/psoxy-test/cli-call.js -u [your_psoxy_url]/api/discovery.conversations.info?channel=[channel_id]&limit=1

Recent Workspace Conversations

node tools/psoxy-test/cli-call.js -u [your_psoxy_url]/api/discovery.conversations.recent