Update a Webhook

This API allows you to update an existing webhook.

It is mandatory to pass the Webhook Id of the webhook you wish to update.

 

API URL

POST
https://(host)/v2/Webhook.svc/Update?accessKey=AccessKey&secretKey=SecretKey
Copy URL

Request

JSON Body/Payload

Content-Type: application/json

{
"WebhookId": "b1c420d7-9c3e-11e7-b0ab-02e89b2fb8f4",  
"Description": "Updated description",
  "URL": "https://www.example.com",
  "Method": "POST",
  "ContentType": "application/json",
  "WebhookEvent": "1",
  "LandingPageUrls": null,
  "IsSpecificLandingPage": false,
  "NotifyOnFailure": true,
  "WebhookProperties": null,
  "CustomHeaders": [
    {
      "Key": "x-api-key",
      "Value": "j5FtwJk44e6fJHzbKc3fa82pJQQoBa7MebQHXAP"
    },
    {
      "Key": "x-api-key",
      "Value": "j5FtwJk44e6fJHzbKc3fa82pJQQoBa7MebQHXAP6"
    }
  ]
}

JSON Properties

Parameter Description
WebhookId

Identifier that uniquely identifies the webhook in LeadSquared. It is mandatory to pass this parameter while updating a webhook.

Description

You can add any text here to describe the webhook.

URL

Specify the URL you want the data posted to. You may use a HTTP or a HTTPS URL. In most cases HTTP is sufficient, but HTTPS can be useful if your data is sensitive.

Method

The HTTP method, which will always be POST in this case.

ContentType

The format you want the data to be posted in. Supported formats are:

  • application/json
  • application/x-www-form-urlencoded
  • text/plain
WebhookEvent

A number that represents the event on which the webhook will trigger:

1 – Landing page submission

2 – Lead activity create

3 – Lead create

4 – Lead owner change

5 – Lead stage change

6 – Lead update

7 – Task create

8 – Task reminder

9 –  Lead score change

15 – Lead activity update

16 – Tasks complete

17 – Task update

26 – Lead field update

LandingPageUrls

Specifies the landing page(s) on which the event will occur if the event pertains to landing page submission.

IsSpecificLandingPage

This value should be ‘true’ if the list of landing page URLs is provided.

NotifyOnFailure

Entering ‘true’ will ensure that you are notified whenever a webhook fails.

WebhookProperties

If the webhook pertains to a lead activity, pass the activity details as shown below:

{“ActivityEvent”:”247″,
“ActivityData”:”[]”,
“WebPageNames”:”[]”}

CustomHeaders

For security purposes, you can add custom headers in the form of key-value pairs and use them for authentication (e.g., reject all webhook calls where this header isn’t present).You can add up to 10 custom headers.

Note: The custom headers are strings in JSON format so be sure to add /” before the key and value parameters.

Response

200 OK

Content-Type: application/json

{
    "Status": "Success"
}

HTTP Response Code

Code Description
200 OK

This is the status code for successful API call.

401 Unauthorized

The API call was made with invalid access credentials. Check your AccessKey and SecretKey.

400 Bad Request

The message body on the request is not as per API specification. Make sure that content type is set to “application/json” and the JSON body has correct attribute names and structure.

404 Not Found

The API could not be found. Please check the API signature.

429 Too Many Requests

API calls exceeded the limit of 25 in 5 second(s)

500 Internal Server Error

The API called failed. There could be many reasons for it. Check the exception message to get more details.