POST
request to the /api/2023-01/webhooks
endpoint with a JSON payload that specifies the webhook configuration. Here’s an example of a request body:
url
field specifies the URL of your application or service that will receive webhook notifications. The description
field is an optional string that describes the webhook. The filter_types
field is an array of event types that the webhook will be subscribed to. In this example, the webhook will only be notified about opportunity created events.
The secret
field is an optional secret key that can be used to sign and verify webhook payloads. If provided, Buildr API will include a signature in the webhook payload that can be used to verify the authenticity of the payload.
The rate_limit
field is an optional integer that specifies the maximum number of webhooks that can be sent to the endpoint per minute. If not specified, the default rate limit is 60 webhooks per minute.
Detailed API documentation for creating webhooks can be found here
id
of the new opportunity and its url
on the Buildr platform.
contact.create
contact.update
opportunity.create
opportunity.update
company.create
company.update
secret
field to sign and verify webhook payloads. When you receive a webhook payload, you can verify its authenticity by calculating a signature using the same secret key that you provided in the webhook configuration, and comparing it to the signature included in the payload.
Here’s an example of how to verify a webhook payload in Node.js (Express):