Slack Key integration
A Slack Key integration is required to send notifications to channels or rooms for CI and Assembly Line events.
Creating an Integration
- Follow instructions in the Slack docs to create an incoming webhook.
- Copy the text in the 'Webhook URL' section. It looks like this:
- To add your integration, follow steps on the Adding an integration page. Here is the information you need to create this integration:
- Integration type -- Slack
- Name -- choose a friendly name for the integration
- WebhookUrl -- Webhook URL to your Slack channel. This can be overridden when creating a resource.
Usage in CI
Usage in Assembly Lines
The Slack integration can be used in the following resources:
Default Environment Variables
When you create a resource with this integration, and use it as an
OUT for a
runCI job, a set of environment variables is automatically made available that you can use in your scripts.
<NAME> is the the friendly name of the resource with all letters capitalized and all characters that are not letters, numbers or underscores removed. Any numbers at the beginning of the name are also removed to create a valid variable. For example,
my-key-1 will be converted to
my_key_1 will be converted to
||Webhook URL of the Integration|
Shippable Utility Functions
The platform also provides a command line utility called
shipctl that can be used to retrieve the values of these environment variables.
The specific function that can be used in the jobs yml is:
shipctl get_integration_resource_field <resource name> <field name>.
Here is a table that provides the mapping from the environment variable to the field name.
|Environment variable||Field Name|
More information on other utility functions is documented here.