Skip to content

Webhooks

Last update · 3 min read

A webhook is an address in your system that RU4M notifies. When one of your events or companies changes, RU4M sends a signed request to that address.

Before you start

You need approved integration access. Read Requesting integration access if you do not have it yet. Only a company's Owner or Admin can open these pages.

You can have up to 10 webhooks. The new webhook page shows how many are in use, for example 2 of 10 webhooks in use.

The address must start with https://. Your system must accept the request and check its signature with the signing secret. A signing secret is a password that proves the request came from RU4M.

If RU4M has suspended your access, New webhook is disabled and RU4M sends no deliveries. Read Overview, deliveries and audit.

Where to find it

  1. Select Integrations in the bar on the left.
  2. Select Webhooks in the Integrations panel.

You can also open Webhooks directly. The New webhook button is also on the Overview page.

The table lists each webhook with its URL, Events, Status and Created date. Use Search webhooks… to find a webhook by its address.

Adding a webhook

  1. Select New webhook.
  2. Type your address into Endpoint URL.
  3. Optionally, type a Description.
  4. Under Events, select at least one event.
  5. Look at Payload you receive to see a sample of the data RU4M sends.
  6. Keep the switch on Active to start deliveries right away. Switch it to Paused to start later.
  7. Select Create webhook.
  8. Select Copy secret.
  9. Paste the secret into your system's configuration.
  10. Tick I have saved this secret somewhere safe.
  11. Select Done.

The page Your signing secret is ready shows the secret once. You cannot see it again. Your system uses it to verify the signature of every delivery.

The new webhook appears in the table with the status Active or Paused.

Pausing and turning on a webhook

Use the switch in the Status column.

  • Switch it off to pause the webhook. The app confirms Webhook paused. RU4M sends nothing while it is paused.
  • Switch it on to start deliveries again. The app confirms Webhook turned on.

Managing a webhook

Open the actions menu at the end of the webhook's row. It offers four actions.

Editing a webhook

  1. Select Edit.
  2. Change the address, the description, the events or the status.
  3. Select Save changes.

The app confirms Changes saved. If you leave with unsaved changes, the app asks Discard your changes?.

Sending a test

  1. Select Send test.
  2. Select Send test in the Send a test delivery? dialog.

RU4M sends one sample event to your address. The app confirms Test delivery sent. Check the result on the Deliveries page.

Rotating the signing secret

Rotate the secret when you lost it or think someone else has seen it.

  1. Select Rotate secret.
  2. Select Rotate secret in the Rotate the signing secret? dialog.
  3. Select Copy secret in the New signing secret card.
  4. Tick I have saved this secret somewhere safe.
  5. Select Done.

The old secret stops working immediately. Update your system with the new secret right away.

You can also rotate the secret on the edit page, in the Signing secret card.

Deleting a webhook

  1. Select Delete.
  2. Select Delete webhook in the Delete this webhook? dialog.

Deliveries to that address stop immediately. You cannot undo this. The app confirms Webhook deleted.

You can also delete a webhook on the edit page, in the Delete webhook card.

After access is approved again

When RU4M revokes access, it pauses all your webhooks. They show Paused when access was revoked.

After RU4M approves a new request, the webhooks stay paused. The edit page shows This webhook was paused when integration access was revoked. Turn each webhook back on with its switch.

Troubleshooting

Your system receives nothing. Check that the webhook is Active and that the Endpoint URL is correct. Then open the Deliveries page and look at the status and response of each attempt.

You lost the signing secret. RU4M cannot show it again. Rotate the secret to get a new one.

New webhook is disabled. You already have 10 webhooks, or RU4M has suspended your access. Delete a webhook you no longer use.

Rotate secret is disabled. A new key or secret is still waiting on this page. Select Done on that card first.

The app asks "Leave without saving the secret?" You are leaving before you copied the secret or ticked the checkbox. Select Stay and copy the secret.

Back to Integrations