Good news! Punchlist now has webhook integration capabilities so you can connect your favorite applications and make feedback management even easier. With Punchlist webhooks, you can:
- Set up your own custom integrations and workflows with ease
- Boost your team’s productivity by integrating Punchlist into your workflow
- Get notified on other platforms automatically when changes are made in Punchlist
What Are Webhooks?
Webhooks are automated messages sent from one app to another when a specific event occurs. They’re a way for your apps to talk to each other and share information automatically.
For instance, when something happens in Punchlist—like a new project being created or an item’s status changing—a webhook can automatically notify another application you use, triggering an action or updating information.
How Do Webhooks Work?
Webhooks work by connecting two systems. When an event occurs in the first system, a payload is sent via an HTTP POST to the other application’s webhook endpoint. This request contains a payload holding important information about the event that triggered the request such as project details, user information, and item metadata.
The tool at the other end of the event processes the incoming data. This could be another project management tool, a CRM, an analytics platform, or any other application that supports webhooks. Here are the actions you can take in Punchlist that trigger a webhook:
- Project created
- Project updated
- Project archived
- Feedback item created
- Feedback item updated
- Feedback item deleted
How Do You Use a Webhook?
You use a webhook by connecting Punchlist to a webhook endpoint. An endpoint is a specific, public URL that belongs to the receiving system.
Once they’re connected, you’ll receive payloads in the endpoint system whenever an event is triggered in the requesting system.
How to Create a Webhook
- Go to your Punchlist workspace settings > Developers > Add a Webhook
- Enter the URL of the endpoint
- Click Add
- The webhook will populate under the section Manage Webhooks
Now any time an event is triggered in Punchlist, the webhook endpoint will receive the appropriate payload.
Note: Each user will only have access to two active webhooks at a time.
Request and Payload
Whenever an action triggers the webhook, a POST request with a JSON payload will be sent by Punchlist to the endpoint you added. Here are the triggerable actions and examples of the payload:
Project Created
{
"event": "project.created",
"data": {
"id": "505e30ce-6cdc-4cf9-9ee8-4388ce1f4bbe",
"name": "Figma Demo 3",
"url": "https://app.punchlist.com/projects/zULCFDjLBgWc2lx9",
"thumbnail_url": null,
"type": "figma",
"owner": {
"name": "Nic",
"email": "nic@punchlist.com"
}
}
}
Project Updated
{
"event": "project.updated",
"data": {
"id": "505e30ce-6cdc-4cf9-9ee8-4388ce1f4bbe",
"name": "Figma Demo 3",
"url": "https://app.punchlist.com/projects/zULCFDjLBgWc2lx9",
"thumbnail_url": "https://cdn.filestackcontent.com/security=policy:
eyJleHBpcnkiOjIwMzE2NTY0MDcsImNhbGwiOlsicGljayIsInJlYWQiLCJzdG9yZSIsImNvbnZlcnQiLCJyZW1vdmUiXX0=,
signature:6393a4fca0be3e527bbec92f48697bf115112ed38ff1ae456e648f05400c110b/
resize=w:720,h:450,f:crop,a:top/7YBKHBSqTqGAHuUxMVyo",
"type": "figma",
"owner": {
"name": "Nic",
"email": "nic@punchlist.com"
}
}
}
Project Archived
{
"event": "project.archived",
"data": {
"id": "6f03d6fb-bf61-4599-833d-2bc69cf38939"
}
}
Feedback Item Created
{
"event": "item.created",
"data": {
"url": "https://app.punchlist.com/items/8c6b5db2-3f99-45ac-af55-ba8ca37a88a6/show",
"owner": {
"name": "Mo Punch",
"email": "worth.mcfall@punchlist.com",
"is_team_member": false
},
"project": {
"name": "Figma Demo 3",
"url": "https://app.punchlist.com/projects/zULCFDjLBgWc2lx9"
},
"content": {
"html": "
Change copy to:
"Get a Demo""
""