slack

Embed
Preview of the card
<a href="https://hermeticor.com/docs/ref-slack"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/b26af22a-896b-4c92-aedb-01970062fb89/social-card.svg?v=3e7ae33eec8b" alt="slack" width="600" height="315"></a>
GEThttps://hermeticor.com/v1/slack/installs

Slack workspaces the app is installed in

Parameters

limitintegerquery
Page size; omitted returns the whole list
cursorstringquery
Opaque: the nextCursor of the previous page

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/slack/installs" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "teamId": "string",
      "teamName": "string",
      "botUserId": "string",
      "scopes": [
        "string"
      ],
      "status": "active",
      "createdAt": "string"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem249[]required
Show child parameters
idstringrequired
teamIdstringrequired
teamNamestringrequired
botUserIdstringrequired
scopesstring[]required
statusstringrequired
active | revoked
createdAtstringrequired
nextCursorstringrequired
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · GET /v1/slack/installs

POSThttps://hermeticor.com/v1/slack/installs

Install with your own Slack app's bot token (stored encrypted)

Request body

application/json
botTokenstringrequired
{
  "botToken": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/slack/installs" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"botToken":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "id": "string",
  "teamId": "string",
  "teamName": "string",
  "botUserId": "string",
  "scopes": [
    "string"
  ],
  "status": "active",
  "createdAt": "string"
}
Schema
idstringrequired
teamIdstringrequired
teamNamestringrequired
botUserIdstringrequired
scopesstring[]required
statusstringrequired
active | revoked
createdAtstringrequired
4XX Default Response

Same as 4XX · GET /v1/slack/installs

5XX Default Response

Same as 4XX · GET /v1/slack/installs

DELETEhttps://hermeticor.com/v1/slack/installs/{id}

Remove a Slack workspace and delete its token

Parameters

idstringpathrequired

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/slack/installs/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "ok": true
}
Schema
okbooleanrequired
true
4XX Default Response

Same as 4XX · GET /v1/slack/installs

5XX Default Response

Same as 4XX · GET /v1/slack/installs

POSThttps://hermeticor.com/v1/slack/oauth/start

Start "Add to Slack"; returns Slack's authorize URL

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/slack/oauth/start" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "url": "string"
}
Schema
urlstringrequired
4XX Default Response

Same as 4XX · GET /v1/slack/installs

5XX Default Response

Same as 4XX · GET /v1/slack/installs

GEThttps://hermeticor.com/integrations/slack/callback

Parameters

typequery
additionalPropertiesstringquery

Code samples

cURL
curl -X GET "https://hermeticor.com/integrations/slack/callback"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response

Same as 4XX · GET /v1/slack/installs

5XX Default Response

Same as 4XX · GET /v1/slack/installs

GEThttps://hermeticor.com/v1/slack/templates

Slack message templates

Parameters

limitintegerquery
Page size; omitted returns the whole list
cursorstringquery
Opaque: the nextCursor of the previous page

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/slack/templates" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "name": "string",
      "text": "string",
      "blocks": [
        {}
      ],
      "createdAt": "string"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem250[]required
Show child parameters
idstringrequired
namestringrequired
textstringrequired
blocksobject[]required
createdAtstringrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · GET /v1/slack/installs

5XX Default Response

Same as 4XX · GET /v1/slack/installs

POSThttps://hermeticor.com/v1/slack/templates

Create a Slack message template (text plus optional Block Kit blocks)

Request body

application/json
namestringrequired
textstringrequired
blocksobject[]
{
  "name": "string",
  "text": "string",
  "blocks": [
    {}
  ]
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/slack/templates" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","text":"string","blocks":[{}]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "id": "string",
  "name": "string",
  "text": "string",
  "blocks": [
    {}
  ],
  "createdAt": "string"
}
Schema
idstringrequired
namestringrequired
textstringrequired
blocksobject[]required
createdAtstringrequired
4XX Default Response

Same as 4XX · GET /v1/slack/installs

5XX Default Response

Same as 4XX · GET /v1/slack/installs

PUThttps://hermeticor.com/v1/slack/templates/{id}

Edit a Slack message template

Parameters

idstringpathrequired

Request body

application/json
namestringrequired
textstringrequired
blocksobject[]
{
  "name": "string",
  "text": "string",
  "blocks": [
    {}
  ]
}

Code samples

cURL
curl -X PUT "https://hermeticor.com/v1/slack/templates/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","text":"string","blocks":[{}]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 201 · POST /v1/slack/templates

4XX Default Response

Same as 4XX · GET /v1/slack/installs

5XX Default Response

Same as 4XX · GET /v1/slack/installs

DELETEhttps://hermeticor.com/v1/slack/templates/{id}

Delete a Slack message template

Parameters

idstringpathrequired

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/slack/templates/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · DELETE /v1/slack/installs/{id}

4XX Default Response

Same as 4XX · GET /v1/slack/installs

5XX Default Response

Same as 4XX · GET /v1/slack/installs

POSThttps://hermeticor.com/v1/slack/test

Post a test message to a channel. Needs an idempotency key

Request body

application/json
installIdstringrequired
channelstringrequired
templateIdstring
textstring
idempotencyKeystring
{
  "installId": "string",
  "channel": "string",
  "templateId": "string",
  "text": "string",
  "idempotencyKey": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/slack/test" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"installId":"string","channel":"string","templateId":"string","text":"string","idempotencyKey":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

202 Default Response
Example
{
  "status": "sent",
  "reason": "string"
}
Schema
statusstringrequired
sent | blocked | failed | duplicate
reasonstringrequired
4XX Default Response

Same as 4XX · GET /v1/slack/installs

5XX Default Response

Same as 4XX · GET /v1/slack/installs

GEThttps://hermeticor.com/v1/slack/sends

Recent Slack sends with their outcome

Parameters

limitintegerquery
Page size; omitted returns the whole list
cursorstringquery
Opaque: the nextCursor of the previous page

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/slack/sends" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "installId": "string",
      "profileId": "string",
      "target": "string",
      "status": "sent",
      "reason": "string",
      "createdAt": "string"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsobject[]required
Show child parameters
idstringrequired
installIdstringrequired
profileIdstringrequired
targetstringrequired
statusstringrequired
sent | blocked | failed
reasonstringrequired
createdAtstringrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · GET /v1/slack/installs

5XX Default Response

Same as 4XX · GET /v1/slack/installs

Updated