Skip to main content

Configuring Webhooks

Set up a webhook so Crelate notifies your system when a Contact, Company or Job is created, updated or deleted (Business Plus and up).

L
Written by Lauren Hickey-Jednat

Send record changes from Crelate to your own system with a webhook

A webhook makes Crelate send a short message to an address you choose each time a Contact, Company or Job is created, updated or deleted. Your system can then react without checking Crelate over and over.

Webhooks are available on the Business Plus and Enterprise plans. Only an administrator can add one.

A Crelate webhook only sends messages out of Crelate. To create or update Crelate records from another tool, use the Crelate API.


Before you add a webhook

Make sure you have these ready:

  • An administrator login in a Business Plus or Enterprise organization.

  • A web address (URL) that you own, that Crelate can reach from the public internet, and that is ready to receive a POST request. Use an https address. Addresses on a private network, such as localhost or an internal server name, are refused.

  • A receiver that answers within 5 seconds (see "What happens when a delivery fails" below).


Add a webhook

  1. Go to Settings > SECURITY > API Access.

  2. Find the Webhooks section below the list of users.

  3. Select the Add new webhook icon.

  1. In the New Webhook window, fill in all four fields:

  • Name: a label you will recognize, up to 255 characters.

  • Url: the address Crelate will send the message to, up to 255 characters.

  • Entity: Contacts, Companies or Jobs.

  • Operation: Create, Update or Delete.

  1. Select OK. The new webhook starts out On.

Each webhook listens for one entity and one operation. To hear about both new and changed Contacts, add two webhooks. Crelate will not let you add the same URL twice for the same entity and operation.

If you do not see the Add new webhook icon, your plan does not include webhooks. Contact your Success Manager or Support.

Developers can also create a webhook with `POST /webhooks` in the API. See September 2026 - API Updates.


What Crelate sends

Crelate sends an HTTP POST with a JSON body. It tells you that a record changed. It does not include the record itself.

The message contains:

  • `entityId`: the ID of the record that changed.

  • `entityName`: `Contacts`, `Companies` or `Jobs`.

  • `operationName`: `Create`, `Update` or `Delete`.

  • `externalPrimaryKey`: the record's external primary key, or empty if it has none.

  • `fields`: for an Update only, the fields that changed. It is not filled in for Create and Delete. Treat it as a hint and read the record for the real values.

  • `operationTimeUtc`: when the change happened, in UTC.

  • `orgName`: the name of your Crelate organization.

To get the current values, call the API with the `entityId`, for example `GET contacts/{id}` for a Contact. A deleted record can no longer be read, so use the `entityId` and `externalPrimaryKey` from a Delete message to find it in your own system.

The message has no signature or secret. Do not treat it as proof that the message came from Crelate. Read the record from the API before you act on it.


What happens when a delivery fails

Your receiver must answer with a success status (any 2xx) within 5 seconds. Respond first, then do your processing.

  • A slow answer, an error answer, or a redirect counts as a failed delivery.

  • Crelate does not retry a failed delivery. That change is lost unless you catch up another way, such as asking the API for records changed since a date with `modified_after`.

  • After 10 failed deliveries, Crelate turns the webhook Off.

  • Crelate does not email anyone when it turns a webhook Off. If messages stop arriving, check the Status column.

  • If your organization no longer has webhooks on its plan, they stop sending without any message.

To turn a webhook back on, see the next section.


Check, turn on or off, and delete webhooks

Go to Settings > SECURITY > API Access and use the Webhooks section.

  • The list shows Name, Entity Type, Operation Type, Status (On or Off) and Url. Select a user in the list above it to see only that user's webhooks.

  • To see the details of a webhook, double-click its row. The details are read-only. To change a webhook, delete it and add a new one.

  • To turn a webhook on or off, select its row, then select Activate/Deactivate the selected webhook.

  • To delete a webhook, select its row, select Delete the selected webhook, and confirm. This cannot be undone.


What webhooks do not do

  • They cover Create, Update and Delete for Contacts, Companies and Jobs only. There is nothing for notes, tasks, placements, workflow stage moves or applications.

  • They do not include the full record, are not signed, are not retried, and have no Send Test button.

  • Triggers that Zapier creates are separate. They appear in the same list after the Zap has run once. See What is Crelate's Zapier Integration?.


Related articles

Did this answer your question?