A webhook is a message that Tape sends to a web address (a URL) every time a chosen event happens in a database app. It's meant to help other systems react right away, without anyone checking Tape by hand.
You can use webhooks for many things, including:
Telling your accounting system when a new invoice record is created.
Updating a dashboard outside Tape when a lead record changes.
Note:
A webhook belongs to one database app and one event. To react to more events, add one webhook for each.
A webhook starts as
Inactive. It becomesActiveafter the address you entered has been verified. Only active webhooks send messages.Webhooks need a service that receives them. The address must belong to a service that can accept and confirm the message, which usually takes a developer.
Database apps only. Dashboard apps don't have webhooks.
Who can use webhooks?
Webhooks are available on all plans: Free, Plus, and Premium. Learn more about plans →
You need to be a
Workspace adminof the workspace the app is in to add, change, verify, or delete webhooks. To openDeveloper, you needFull accessto the database app.You can't open
Developeron a smartphone. Use Tape on a computer.
Open the webhooks of a database app
Open the database app and click
•••at the top. Its tooltip readsFollow, export and more….Select
Developer.Below
Developer info forand the name of your app, find the sectionWebhooks.
If the database has no webhooks yet, the section says "Add a webhook to get notified about changes in Tape."
Add a webhook
Under
Webhooks, selectAdd webhook. A new row appears.Choose the event in the list next to
Inactive. A new webhook starts withRecord created.Enter the address in
Add URL.Click outside of the field to save it.
Tape saves the address, sends a verification request to it, and shows Verification requested. The address has to start with http:// or https://. If it names a port, the port has to be 80 or 443. Otherwise, Tape marks the field as invalid and doesn't send a verification request. Tape doesn't follow redirects, so enter the final address, including https:// if the service uses it.
Choose an event
Every webhook reacts to one event:
Record created: a record is added to the database.Record updated: a record changes.Record deleted: a record is deleted.Record restored: a deleted record is restored.Comment added: a comment is added to a record.Comment deleted: a comment is deleted.App updated: the database itself is updated.
You can change the event of a webhook at any time with the list in its row.
Verify a webhook
A webhook only sends messages once it's Active. Tape sends a verification request to the address when you save it. To send one again, click ••• (its tooltip reads Options) next to the row and select Verify. Tape shows Verification requested. The service behind the address has to confirm the request. When it does, the row changes from Inactive to Active.
If you change the address of an active webhook, it becomes Inactive and has to be verified again.
If you select Verify and the address isn't valid, Tape shows You need a valid URL for verification. If only the port is wrong, it shows You need a valid URL for verification (port has to be 80 or 443).
Delete a webhook
Click ••• next to the row and select Delete. For an Active webhook, Tape asks Delete webhook? and tells you that this can't be undone. Select Delete to confirm, or Cancel. An Inactive webhook is deleted without a question.
Let's look at an example
Let's say a solar installer wants to know right away when a new lead arrives. Here's how:
The
Workspace adminopens the database app "Leads", opens the app menu, and selectsDeveloper.Under
Webhooks, they selectAdd webhook.They choose
Record createdand enter the address of the system that should receive the message.They wait until the row shows
Active.
From then on, every new record in "Leads" is sent to that address.
Webhook errors
The webhook stays
Inactive. The service behind the address hasn't confirmed the verification. Check that the address is right and that the service is running, then select•••→Verify.No messages arrive. Check that the row says
Activeand that the event matches what you changed. When many events happen at the same time, messages can arrive with a short delay.An active webhook turned
Inactiveon its own. Tape turns a webhook off when many messages in a row to its address fail. Fix the service, then select•••→Verify.Developeris missing in the app menu. You needFull accessto the app. Dashboard apps don't haveDeveloper, and it isn't offered on a smartphone.You can't add or change a webhook. Only a
Workspace admincan.
Test, pause, or edit webhooks
To test a webhook, create or change a record that matches the event and check the receiving service.
To pause a webhook, delete it and add it again later. A webhook has no pause switch.
To change what a webhook reacts to, choose another event in its row, or change the address. A new address has to be verified again.
Learn more
FAQs
Can I add a webhook to a dashboard app or a form app?
Can I add a webhook to a dashboard app or a form app?
No. Webhooks are part of database apps. To react to form submissions, add the webhook to the database app that receives them.
Can one webhook send several events?
Can one webhook send several events?
No. Each webhook reacts to one event. Add one webhook for each event you need.
Can I use more than one webhook per database app?
Can I use more than one webhook per database app?
Yes. You can add one row for each event you need, for example one for Record created and one for Record updated.
What's the difference between a webhook and an automation?
What's the difference between a webhook and an automation?
A webhook sends a message to another service. An automation runs steps inside Tape, and can send requests to other services too. Learn more about automations →
Do imports trigger webhooks?
Do imports trigger webhooks?
Only if you turn on Trigger webhooks in Customize import, under Show more settings. It's off by default. Learn more about importing data →
Are you a developer who wants to create webhooks with code?
Are you a developer who wants to create webhooks with code?
Yes, the Tape API can create, verify, and delete webhooks. Full reference: Tape developer docs →
Still have more questions? Find answers and get help from community experts in the Tape community →.
