WebHooks

What is a Webhook?

A feature that lets you receive real-time notifications when tasks are completed or specific events occur in web apps. When you integrate Listly with enterprise messaging apps like Slack, you can receive real-time notifications when data extraction completes.

---

How to use it

Integrating Slack Webhook

Quick start

➡️ Add Incoming Message app to Slack ➡️ Add webhook to Listly task ➡️ Receive notifications in desired Slack channel via data re-extraction or scheduler

1

Log in to Slack, then click on the following link.

Incoming WebHooks: https://slack.com/marketplace/A0F7XDUAZ-incoming-webhooks

2

Add it to Slack.

After clicking Add to Slack , select which channel to receive notifications in. At this step you can also add a new channel for notifications and set the name of the bot that sends extraction result messages. Copy the Webhook URL needed for Listly service integration, then click save settings.

3

In Listly Databoard, find the task you want to receive result notifications for and click the Data button on the right. Then click the Hook button on the right side of the top menu as shown below to open the webhook settings window.

When the webhook settings window appears, enter the Request Method and JSON values as shown below. In the URL input field, enter the Webhook URL you copied in the previous step.

Method	POST
JSON	See payload below

payload.json

{
  "text": "#taskkey is #status. <[https://www.listly.io/single?key=#taskkey&tab=4&card=30|See](https://www.listly.io/single?key=#taskkey&tab=4&card=30%7CSee) result>\nFrom Listly.",
  "icon_emoji": ":white_check_mark:"
}

4

Re-extract or use the scheduler to extract data for that task again, and you'll receive data extraction notification messages in Slack as shown below.

Other Settings

• If you're familiar with JSON format, you can add channel: #channelname or user: @username to the JSON above to change which channel/user receives notifications. Adding username: botname lets you change the name of the bot sending notifications.

• To learn more about Slack Incoming Webhooks, check out Slack's documentation: https://api.slack.com/legacy/custom-integrations/messaging/webhooks