This article explains how clients can set up webhooks on Deel and manage their webhook notification settings.
You must be an Org Admin or IT Developer Admin on Deel in order to subscribe to webhooks or build apps using Deel's API.
In this article:
What is a Webhook?
Webhooks are automated messages sent by Deel when something happens on our platform. They have an information-bearing payload and are sent to a unique URL. Webhooks are almost always faster than calling Deel API and require less work on your side.
For example, if you want to keep the contract information up to date between Deel and your platform, you will rely on calling Deel API every few hours to retrieve the latest state of contracts, also known as polling. Webhooks enable you to subscribe to a change event in Deel and be notified when the data is updated.
Polling vs. webhooks
When to use webhooks?
If you need updated data in real-time or updates are not very frequent, webhooks are the perfect solution.
Creating a Webhook subscription
Use the following steps to register a webhook endpoint in the Developers Center.
✅ Step 1 – Add Webhook
To find Webhooks in the Developer center, you can go to Apps & Integrations > Developer Center and click on the Webhooks tab.
Now, click on Add Webhook to create your first webhook.
Note: You must have Org Admin or IT Developer Admin permissions on Deel.
✅ Step 2 – Webhook details
Specify the webhook details:
Webhook name - Choose a name for your webhook.
Webhook description - Describe the information this Webhook will push to your application.
Endpoint URL - Specify the endpoint to which you would like to receive live Deel events.
API version - Choose the API version you want to apply to this Webhook.
✅ Step 3 – Select the Events
Select the Events you need to be sent to your chosen endpoint URL
✅ Step 4 – Review
Review your entries and selection.
Click on Finalize Webhook to submit your setup.
✅ Step 5 – Success message
If the Webhook endpoint is enabled and ready to receive the selected event, you will view the success message - Webhook added.
How to edit, disable, or delete your webhooks
You can view all the webhooks you have created, under the Webhooks tab.
For more details about the Webhook, click on the vertical ellipsis icon below the Action column.
You review the existing webhook details and Edit, Disable or Delete a webhook from this page.