Knowledge Base

Knowledge Base/Features/Automations/Automations: webhook ...

Topics
Create a webhook
Add a webhook to automations
Execution history
Permissions and executions

Automations: webhook requests

YS
Yssel Salas, October 15, 2024
Note: Automations and webhooks in automations are only available on Advanced and higher plans. Regular webhooks are available in all plans.

The webhook action in Automations allows you to connect Pipedrive with external tools and apps by sending information to specific endpoints. This feature enhances your sales processes by allowing conditional event-triggered information linking between Pipedrive and the tool of your preference.

Unlike traditional webhooks, this approach offers greater flexibility and precision, allowing you to define detailed conditions and events for triggering webhook requests – a capability not available in standard webhook setups.


Create a webhook

Note: This action is only available to global admin users.

Before you start adding webhook actions to your automations, you first need to add webhooks to your Pipedrive account.

Go to the Webhooks page. Then, click on “+ Webhooks” > Automation webhook.

Note: Existing webhooks can’t be re-used for automations.

Add a name to your webhook. We recommend being very specific and clear, as you’ll have to choose the webhook by the name while building an automation.

Then, add the endpoint URL and provide authentication credentials if required.

Note: Automation supports the use of base domains and more specific domain endpoints, also known as paths. To prevent the creation of incorrect URLs, the endpoint URL must conclude with a “/”, “&”, “?” or “=” character. When constructing an automation and employing the webhooks action, you can select the paths option to specify these endpoints.

Add a webhook to automations

Note: If webhooks are not pre-built, you won’t be able to add the webhook action.

Once you’ve added the webhooks, you can head to automations and start building an automation with a webhook action.

You’ll see the following fields to fill in in the webhook action, being “Webhook”, “Method” and “Body” mandatory.

First, select the webhook you created from the webhook field.

Then, choose the method you want to use (POST, PUT or DELETE).

POST
Create resources
PUT
Replace a resource with another one
DELETE
Delete a resource

In the webhook body, you can choose to set it up by “Key-value” or “Raw”.

The key-value builder allows you to build the request body of the action and add more entries if needed. Here, you can select Pipedrive fields by clicking on the field button to open the dropdown.

The raw builder allows you to build your own JSON-valid body in case you want more control over the payload.

Finally, add the webhook path. The path will be added to the base domain defined in the webhook.


Execution history

You can have visibility over your webhook performance within the execution history. Here you’ll see the final body and path for the webhook request.

If, for any reason, the webhook is not working anymore or is missing authentication or permissions, the automation execution will fail.

Note: Webhook execution will work according to existing automation execution limits. If they’re reached, the execution of webhook requests will be paused.

Permissions and executions

Automated webhooks can be triggered by all users, regardless of their visibility permissions or admin status/permission.

Was this article helpful?

Yes

No

Related articles

Got any questions?

Contact us