Set up a webhook for feed activity

A webhookWebhook An address you give the hub so it can send your own systems a message whenever a feed post or comment changes. sends your own system a message each time something you choose happens on a case's FeedFeed The timeline of updates on a case, where the firm posts news and everyone on the case can comment., such as a new post or comment. Each message is encrypted, so the system receiving it needs a developer's code to read it.

1. 1

   Open Webhooks

   Go to Integration › Webhooks and choose NEW.

2. 2

   Enter the address

   Under URL, type the address on your system that receives the messages, such as https://crm.example.com/hooks/caseactive. It must start with https:// or http:// and be reachable from the internet. Capital letters are kept as you type them.

   Description is optional: a note for your team, such as Case updates to our CRM.

3. 3

   Choose the events

   Under Events, pick each one that should send a message, such as post is created and post comment is created. There are ten, for posts, comments on posts, and files added to or removed from either. Look up webhook events and payloads says what each sends.

4. 4

   Switch it on and save

   Active starts on. Leave it on: an inactive webhook receives nothing, and what it misses isn't sent later. Choose SAVE. "Webhook added" shows.

5. 5

   Keep the secret

   The Secret Webhook window shows the webhook's secret: the private key that unlocks every message it sends. It's shown only this once. Choose Download as .pem file to save it as a file, or Copy to clipboard to copy all of it, line breaks included. Pass it to your developer safely, such as through a password manager. Then choose Done.

6. 6

   Test it

   Post a short update on a case with no real clients on it, such as one of the two sample cases your hub started with. Your developer checks that a message arrived and that the secret reads it.

What happens next

Each time a chosen event happens on any case in your hub, the webhook sends your system a message, whoever made the change: your team, a client, the Virtual AssistantVirtual Assistant An automated team member that posts welcome messages, check-ins and stage updates for the firm; its posts carry a Virtual Assistant badge., an import or an API key. Nobody else is told.

If two deliveries in a row fail, the webhook stops and each Admin is emailed; see Fix a webhook that stopped sending. To change its address or events, choose the pencil icon, Edit webhook, on its row. The secret stays the same.

If something goes wrong

• "Webhook limit has been reached." Your hub can have five webhooks. Delete one you no longer use: choose the bin icon, Delete webhook, on its row, then Delete. It stops at once and can't be brought back.
• The URL says "URL is invalid. Example: https://example.com/hook" Type the whole address, starting with https:// or http://. An address that only works on your own computer isn't accepted.
• You lost the secret. It can't be shown again. Add a new webhook with the same address and events, give its secret to your developer, then delete the old one.