Pipeliner CRM Cloud API

Introduction

Webhooks trigger in-app and/or email notifications whenever an event occurs, such as a new record creation, or an existing record update. In the Pipeliner CRM, records refer to entities, such as Leads, Contacts, Accounts, and Opportunities.

You can create webhooks to receive notifications using the Pipeliner CRM user interface or the Pipeliner APIs. This tutorial is divided into two sections and explains how to create and update webhooks to receive notifications using APIs when the following events occur. 

  • Part 1: Creation of an Opportunity
  • Part 2: Update of an existing Opportunity

Note: For information about creating webhooks in the Pipeliner CRM UI, see In-App and Email Notifications.

Section 1: Create a Webhook for Opportunity Creation Event

You can create a webhook using the Webhooks.create endpoint. However, before you can use this endpoint, you must have the following details.

  • Service URL
  • Space ID

Note: For information about how to obtain the Service URL and Space ID details, see About APIs.

Parameters

There are various parameters that you can pass as payload to create a webhook.

The following table describes the mandatory parameters required to add as payload to the HTTP request for creating a webhook for the Opportunity.Create event.

Parameter name Value Description
insecure_ssl boolean Required. Set this parameter to true to indicate if the remote-side SSL certificate will not be validated when delivering notifications.
url string Required. Set the webhook URL with a port number for local testing.

Note: If you do not provide a port number, your testing of the web service will fail.

events Array of strings Required. Specify one or more events for which you want to create a webhook.

Endpoint name: Webhooks.create

This endpoint uses the POST method to create a new webhook.

Request URL Syntax

Copy to Clipboard

Example Request URL

Copy to Clipboard

Example Request Body

The request body is passed as raw JSON data format.

Copy to Clipboard

Example Response

Copy to Clipboard

Status Code

Success: true

After passing the POST request to create a webhook, if you get the “success”: true message, then it means the webhook is created successfully.

Section 2: Create a Webhook for Opportunity Update Event

Whenever there is an update to any Opportunity, you can trigger notifications using webhooks. For example, you can create a webhook for the Opportunity.Update event to trigger when an Opportunity is qualified.

Similarly, you can create a webhook for the Opportunity.Update event to trigger when the primary_contact, primary_account, owner_id, or other associated details of an Opportunity is changed.

The following section of this tutorial explains how you can update the webhook you created in Section 1 using the Webhooks.update endpoint. However, before you can use this endpoint, you must have the following details.

Note: To create a new webhook for the Opportunity.Update event, follow the procedure explained in the Section 1 of this tutorial.

  • Service URL
  • Space ID

Note: For information about how to obtain the Service URL and Space ID details, see About APIs.

Parameters

There are various parameters that you can pass as payload to update a webhook.

The following table describes the mandatory parameter required to add as payload to the HTTP request header for updating a webhook for the Opportunity.Update event.

Parameter name Value Description
id string Required. Specify the ID of the webhook to update.

Endpoint name: Webhooks.update

This endpoint uses the PATCH method to update a webhook.

Request URL Syntax

Copy to Clipboard

Example Request URL

Copy to Clipboard

Example Request Body

The request body is passed as raw JSON data format and the Opportunity.Update event is triggered if an Opportunity is qualified.

Copy to Clipboard

Example Response

Copy to Clipboard

Status Code

Success: true

After passing the PATCH request to update a webhook, if you get the “success”: true message, then it means the webhook is updated successfully.