How to Set Up a Webhook for Your Forms

By the end of this doc, you'll be able to:

• Understand what a webhook does and when your site needs one
• Set up a webhook and store its signing secret safely
• Edit, pause, rotate or delete a webhook
• Send a test submission to check your webhook works

Overview

A webhook is a message your site sends to another tool the moment something happens. When a visitor submits a form on your published Relume site, a webhook delivers that submission to a web address you choose, such as your CRM, a Slack bot, your own database, or an automation tool like Zapier or Make. New leads land where your team already works, without anyone copying them across by hand.

Before You Begin

• A published Relume site with at least one form on it.
• A web address that can receive the data, called an endpoint. It must be reachable from the public internet and start with https://.
• A safe place to store a secret key, such as a password manager.

If you don't have an endpoint yet, an automation tool such as Zapier or Make can give you one in a few clicks, or your developer can build one. Developers can find the technical reference in the Relume API docs.

Note: Relume only sends to public addresses. An address on your own computer (localhost) or inside a private company network won't work.

Set Up a Webhook

Add the Webhook

1. Open your site in the editor.
2. Click Site settings (the gear icon) in the header.
3. Open the Integrations tab.
4. In the Webhooks card, click Add webhook.
5. Enter a Name that says what the webhook is for, such as Marketing leads.
6. Add a Description if you want one.
7. Paste your address into Endpoint URL.
8. Under Events, select Form submitted.
9. Click Add.

Save the Signing Secret

Next, Relume shows the webhook's signing secret: a key your endpoint uses to check that each message really came from Relume.

1. Copy the Signing secret.
2. Store it somewhere safe, such as your password manager.
3. Click Done.

Warning: Relume shows the signing secret once and never again. Copy it before you close the window. If you lose it, your only option is Rotate secret, which replaces it with a new one.

Your webhook starts working straight away. The next form submission on your site goes to your endpoint.

Edit, Pause or Delete a Webhook

Click the ⋯ menu next to a webhook in the Webhooks card, then choose an option:

• Edit: change the name, description, endpoint URL or which events it listens for.
• Enable / disable: pause deliveries without removing the webhook. A disabled webhook receives nothing until you turn it back on.
• Rotate secret: replace the signing secret with a new one. The old secret stops working the moment you rotate, so have your developer ready to swap in the new one.
• Delete: remove the webhook. Its past deliveries stay in the delivery log.

Each site can have up to 20 webhooks. A webhook that listens for two events counts as two.

Test Your Webhook

1. Open your published site.
2. Fill in one of your forms.
3. Submit the form.
4. Check the tool you connected for the new submission.

If the submission doesn't arrive, check the Endpoint URL and make sure the webhook is enabled.

Tips & Best Practices

Tip: Name webhooks after what they feed, not where they point. Marketing leads tells your team more than Zapier hook 2 a year from now.

Tip: Rotating a secret takes effect instantly, with no overlap. Update your endpoint with the new secret first, then rotate, so no deliveries fail in between.

Tip: Webhooks only send submissions made after you add them. For older submissions, export a CSV from the Forms tab.