A webhook keeps the people who aren't in the canvas in the loop. When someone comments, assigns an action or makes a share link, a message lands in your team's channel straight away, with a link back to the canvas. A webhook belongs to one canvas and only ever reports on that canvas.
Opening Webhooks
In the editor, open Tools at the end of the bottom bar and press Webhooks. In the Explorer, choose Webhooks from the canvas's ⋯ menu. Both open the same list of the canvas's webhooks.
Adding a Webhook
Press Add Webhook and work through the four steps:
- Where Should It Post? Choose Slack, Microsoft Teams or Your Own Service.
- Connect It. Paste the address your service gives you. For Slack and Microsoft Teams, the dialog shows how to get one. Give the webhook a Name, such as the channel it posts to.
- What Should It Send? Tick the changes it should hear about: Canvas Renamed, Canvas Moved, Canvas Moved to the Trash, Share Link Made, Comment Added, Action Assigned and Action Done. Select All ticks them all.
- Who Did It? Anyone, or Only Me to send only your own changes.
Press Add Webhook to finish. For your own service, each change arrives as a signed JSON POST, and the secret that signs it is shown once, when you add the webhook, so copy it then.
Managing Webhooks
Each webhook in the list shows where it posts, who added it and what it sends:
- Send Test sends a test message, so you can check the channel or service receives it.
- Pause Webhook stops it sending, and Resume Webhook starts it again.
- Edit Events changes what it sends and Who Did It.
- Recent Deliveries lists what it sent lately and whether each one arrived.
- Delete Webhook removes it, after asking.
A webhook that keeps failing pauses itself and says why, so a broken address never fills up with retries. A canvas can have up to 10 webhooks.
Who Can Use Webhooks
You need to be signed in and able to edit the whole canvas: its owner, someone in its team, or someone with an Editor link to every tab. Anyone who can do that manages every webhook on the canvas, whoever added it. Participants, Viewers and Editors of a single tab don't, and a canvas kept in This Browser needs to be synced first. A team canvas's webhooks are recorded in the team's audit log.
Was this article helpful?
Still need help?
Try Troubleshooting, or tell us what you were trying to do.