Skip to main content

How do I set up webhooks on the dashboard?

A webhook makes Assignar send details to another system's web address (URL) when something happens: for example, when a timesheet is created or a form is submitted.

A webhook makes Assignar send details to another system's web address (URL) when something happens: for example, when a timesheet is created or a form is submitted. You set webhooks up on the Assignar dashboard under Settings > Webhooks. You need someone technical to give you the receiving URL and to handle what Assignar sends.

Your company can rename some words in Assignar, so you might see your own word instead of Forms on the tabs.

Before you start

  • Assignar must switch webhooks on for your company. If Webhooks is not in anyone's Settings menu, contact Assignar Support from Support > Get Support.

  • You need the Webhooks permission on your User Access tab ("Allows user to administer webhooks."). Users with Read Only can see webhooks but not add or change them.

  • Have the receiving URL ready. It must start with http:// or https://.

The three webhook tabs on the dashboard

The Webhooks page on the Assignar dashboard has three tabs:

  • Global: webhooks for events across your company, such as a timesheet being created.

  • Forms: webhooks for one form, sent when that form is submitted, edited or changes status.

  • Legacy: three older webhooks for a new client, a new contact and an order being pushed. Each is a single URL.

Add a global webhook on the dashboard

To add a webhook for a company-wide event on the Assignar dashboard:

  1. In the left menu, open Settings and click Webhooks.

  2. On the Global tab, click New Webhook. A panel opens on the right.

  3. Type a Webhook Name, for example "Timesheets to payroll".

  4. Paste the receiving address into URL (for example https://example.com/webhook).

  5. Pick the Event, for example Timesheets - create (v1).

  6. Click Save.

  7. The dashboard shows "Webhook created successfully" and the webhook appears in the list.

Add a webhook for one form on the dashboard

To send a webhook only for one form on the Assignar dashboard:

  1. Go to Settings > Webhooks and open the Forms tab.

  2. Click New Webhook.

  3. Type a Webhook Name and paste the URL.

  4. Pick the Event: submit, change status or edit.

  5. Pick the form in Form ("Select a Form..."), for example Toolbox Talk. Archived forms are not listed.

  6. Click Save. The dashboard shows "Webhook created successfully".

The Forms tab list shows each webhook's Form ID and Form Name.

Change, archive or export webhooks on the dashboard

To change a webhook on the Assignar dashboard, click it in the list, change its Webhook Name or URL and click Save. The dashboard shows "Webhook updated successfully". You can't change a webhook's Event or Form after it's created: archive it and add a new one instead.

To archive webhooks on the dashboard:

  1. On the Global or Forms tab, tick the webhooks.

  2. Click Archive. The dashboard shows "Webhook archived successfully".

Archived webhooks move to the Archived filter at the top right of the list. To use one again, show Archived, tick it and click Unarchive.

To download the list, tick the webhooks and click Export.

To find a webhook, type in Search webhooks..., or use the advanced search to filter by Created By.

Set up a legacy webhook on the dashboard

To set up one of the older single-URL webhooks on the Assignar dashboard:

  1. Go to Settings > Webhooks and open the Legacy tab.

  2. Type the receiving URL in the field for the event:

    • Client Added: "Fires when a new Client is created."

    • Contact Added: "Fires when a new Contact is created."

    • Order Push: "Fires when an Order is pushed to an external system."

  3. Click Save. The dashboard shows "Webhook URL saved successfully".

To stop a legacy webhook, clear its URL and click Save.

What does Assignar send to a webhook?

For the Contact Added legacy webhook, Assignar sends a POST request to your URL with the new contact's details as JSON. It waits up to 10 seconds for your system to answer and doesn't try again if the request fails. For the data each Global and Forms event sends, contact Assignar Support from Support > Get Support.

Why can't I add or save a webhook on the dashboard?

These are the messages you might see when you add a webhook on the Assignar dashboard, and how to fix each one.

  • Webhooks is not in the Settings menu. Webhooks aren't switched on for your company, or you don't have the Webhooks permission. Ask an admin to add the permission, or contact Assignar Support to switch webhooks on.

  • There is no New Webhook button. You have the Read Only permission.

  • "Name is required", "URL is required", "Event is required" or "Form is required": fill in that field.

  • "URL must start with http:// or https://": add https:// to the start of the address.

  • "Failed to create webhook", "Failed to update webhook" or "Failed to save webhook URL": the change didn't save. Try again, and contact Assignar Support if it keeps happening.

  • "No webhooks found": nothing matches your search or the Active or Archived filter. Clear the search and check the filter.

Changes to webhooks appear in the audit trail under Webhook and Form Webhook. See How do I view the audit trail on the dashboard?.

Related articles

Did this answer your question?