1. Slack
  2. Send Slack Message

​
πŸ’¬ Steps to send Slack notifications

​
Step 1. Raven Account Setup

If you have not signed up on Raven yet, please sign up for free.

You can either use the default App (<your-account-name_test>) created on sign up or create a new one by going to the Settings tab in the dashboard. To know more please check our platform doc on Apps. Collect your credentials (API Key and App ID) as you will need them in the API to trigger notifications.

​
Step 2. Setup Slack App

You need to create a slack app, if you don’t have one already.

You need to provide following permissions to the Slack Bot Token :

chat:write, im:write, users:read, users:read.email

​
Step 3. Add a Slack Integration

Head over to Channels tab in the dashboard and select Slack.

Once you have added your Integration, you will be able to view it in the Live tab on the dashboard. You can always add/remove/update any integration without having to manage any code.

If you do not see the Integration you are looking for, please email us on support@ravenapp.dev, and we will add it to the list.

​
Step 4. Create an Event

Events define - which notifications to send, what should the content be and how to send them. You can manage all this directly from the dashboard without having to write a single line of code. Check our platform doc on Events for more details.

We first create an event with Slack enabled. In this event, we will add the message content and select the integration to send this notification with (the integration we added in the previous step). Head over to Events tab in the dashboard and click on the Create Event button.

  1. Give a unique name to this event. This name will be used to trigger the event in the Send Event API.
  2. Select Slack as a channel to send notifications. Also, select the Integration that you added earlier in Step 2.
  3. Create the notification template. You can add dynamic text to the template like user name, invoice number, order id etc., with the handlebar notation, like this {{user_name}} For more details on templates, languages etc, please check our Slack Template doc.

Your event is created! You will be able to see it in the Events list now.

​
Step 5. Trigger the Event

Now we just need to test if our setup works. Trigger the event that you created above. You can either do this from the dashboard itself (Go to Events tab > Click on View Event Button (Eye) > Dialog opens > Click on Test Event). The other way is to hit the API directly with cURL or Postman. Below is how the API will look like -

Terminal
curl --location \
--request POST 'https://api.ravenapp.dev/v1/apps/<YOUR_APP_ID>/events/send' \
--header 'Authorization: AuthKey <YOUR_API_KEY>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "event": <YOUR_EVENT_NAME>,
    "user": {
        "slack": {
           "access_token" : "<BOT_ACCESS_TOKEN>",
           "email" : "john@ravenapp.dev",
           "channel_id" : "<CHANNEL_ID>" // either one of email or channel_id is needed
        }
    },
    "data": {
        "user_name": "John Doe"
    }
}'
YOUR_APP_IDApp ID of the currently selected App. Go to Settings > App in the dashboard to view.
YOUR_API_KEYThe Account API Key. Go to Settings > Account in the dashboard to view.
YOUR_EVENT_NAMEName of the Event we created above in Step 2.
BOT_ACCESS_TOKENSlack App Bot Access Token
CHANNEL_IDChannel identifier of the channel where you want to send notification (either channel_id or email is required)
dataThe data object contains β€œkey”: β€œvalue” pairs of any dynamic text that you would have added in the template.

Copy the cURL request and simply hit enter in your terminal.

Great! You should have received an in-app notification successfully. πŸ‘

​
Step 6. Verify in Logs

As a final step, we can verify if everything went well and the notification was sent. Raven provides a single view of all logs across all channels. You can view the request payload, the response and the status of the notification sent. You can check our platform doc on Logs & Metrics for more details.

Head over to Logs tab in the dashboard and click on View icon of the first log entry. You will be able to see the details of the payload and the status of the notification that you sent.

Event Timeline

If you were able to successfully receive the notification, you are all set! πŸ‘

If you are facing any issues, please email us on support@ravenapp.dev