Update Webhook

View as Markdown
# Update Webhook **Endpoint** `PATCH {{baseUrl}}/api/public/webhooks/UpdateWebhook?webhookId=1234` **Description** This API updates an existing webhook by modifying its configuration, such as name, URL, event type, associated campaigns, and status. --- ## Query Parameters - **`webhookId`** (`string`): The unique identifier of the webhook to update. This must be provided as a query parameter. --- ## Request Body Example ``` json { "webhookName": "string", "webhookUrl": "string", "eventType": "CONNECTION_REQUEST_SENT", "campaignIds": [], "isActive": true } ``` ## Request Parameters - **`webhookName`** (`string`): The name of the webhook. If NULL or ommited, the original name will be kept. - **`webhookUrl`** (`string`): The URL to which the webhook will send POST requests. If NULL or ommited, the orignal url will be kept - **`eventType`** (`string`): The type of event that triggers the webhook. If null or ommited, the original will be kept. It must be one of the following values: - `CONNECTION_REQUEST_SENT` - `CONNECTION_REQUEST_ACCEPTED` - `MESSAGE_SENT` - `MESSAGE_REPLY_RECEIVED` - `INMAIL_SENT` - `INMAIL_REPLY_RECEIVED` - `FOLLOW_SENT` - `LIKED_POST` - `VIEWED_PROFILE` - `CAMPAIGN_COMPLETED` - `LEAD_TAG_UPDATED` - **`campaignIds`** (`array`): A list of campaign IDs. If null or ommited, the original array will be kept. If this array is empty, the webhook will listen for the specified `eventType` across all campaigns. If specific campaign IDs are provided, the webhook will listen only to those campaigns. - **`isActive`** (`boolean` | `null`): Determines whether the webhook should be active. If `true`, the webhook is enabled; if `false`, it is disabled. If `null`, the activation status remains unchanged.

Headers

X-API-KEYstringOptional

API key header using this scheme. Example: “X-API-KEY: {API_KEY}

Query parameters

webhookIdintegerOptional

Request

This endpoint expects a string.