The integration with Slack allows you to send messages to a slack channel or customer. A slack app is required to use this integration. The receiving slack workspace must download this app and authorize incoming webhooks.
Prerequisites
Before you can set up integration with Blueshift, you must have your Slack account set up. For more information about the Slack API, visit: https://api.slack.com/incoming-webhooks.
- Obtain the Client ID and Client Secret required for API integration. For more information, see Using OAuth 2.0.
- Set up OAuth in Slack and set the Redirect URL = https://app.getblueshift.com/api/v1/account_app_profiles/oauth_callback
Set up integration
To add a Slack adapter in Blueshift, complete the following steps:
- Sign in to the Blueshift app, and click App Hub in the left navigation menu.
- Go to All Apps, search for, and select Slack.
- You can also go to Instant Messaging Apps and select Slack.
- Click Configure to view all the configured adapters.
- Click +ADAPTER to add an adapter.
- Add a Name for the adapter. If you have multiple adapters, the adapter name helps you to identify the integration.
- Provide the following details for integration:
Field Description Client ID The Client ID for accessing Slack APIs. Client Secret The Client Secret for accessing Slack APIs. Scopes OAuth scopes let you specify exactly how your app needs to access a Slack user's account. As an app developer, you specify your desired scopes in the initial OAuth authorization request.
When a user is responding to your OAuth request, the requested scopes will be displayed to them when they are asked to approve your request.
For more information, see OAuth Permission Scopes.
- Add information for any Additional Headers.
- Click Save to add the adapter.
The adapter is now added and you can use it in your Cloud App template.
Quick start templates
When you create an adapter in the App Hub, the following quick start template is added to the Cloud App templates.
- Send a message
Consider the following points about quick start templates:
- You can find these in the following location: Templates > Cloud App
- Quick start templates are identified by the label "QUICK START".
- A quick start template is added only when you create the first adapter for the app in App Hub. If you have multiple adapters for an app, you can edit the Adapter details on the template Properties tab to select the required adapter.
- You can use this template as-is in your campaigns. You cannot make any changes to the schema for a quick start template.
- If you need to change the schema, you can clone the template and then edit the schema as required.
Next steps
- Configure the Slack quick start template to send a payload from a campaign.
- You can clone the quick start template and edit the schema if required. You can also create a new template.
- In your campaign journey, add a Slack trigger. Select the template that you created.
Configure or create a Slack cloud app template
A Cloud App template is required to send a payload to Slack from a campaign. You can include personalizations and recommendations in the template content. For more information, see Cloud Apps templates.
To use a quick start template or to add a Slack Cloud App template, complete the following steps:
- Go to Templates > Cloud App.
- Complete one of the following actions:
- Select the Send a message quick start template for Slack from the list of templates.
- To create a clone of the quick start template, go to the action menu for the template and click Clone.
- To create a new template, click +TEMPLATES on the Cloud App Templates page. Select the Slack app.
Note: Only apps that support Cloud Apps templates and have atleast one adapter configured are displayed on the Cloud App Templates page.
- Go to the Properties tab and configure the template name, tags and other relevant information.
Field Description Template Name Specify a name for the template to identify it on the index screen. API Endpoint Specify the API endpoint that receives the request that we make.
Slack provides a unique url for each channel/user to send a message. Copy and paste that url into the “API Endpoint” field. Slack does not require authentication headers, so leave the auth fields blank.
For more information about the Slack API, visit: https://api.slack.com/incoming-webhooks.
Adapter Select the adapter to use to send the payload. Tags Specify tags to organize this template.
Since this template is a Blueshift resource that you use in campaigns, you can use tagging to organize it under folders.
For more information on this, see Tagging.
- Go to the Content tab.
- Go to the Content Form tab and fill the form to specify the data to send to Slack.
- If you are using a cloned quick start template or a new template, go to the Schema tab and configure the schema for the form.
- In the preview tab, you can also switch to JSON and view the content in JSON format.
Comments
0 comments