delete
https://{host}/v3/webHooks/
Delete a webhook.
API endpoint example
http://eu.api.capillarytech.com/v3/webHooks/69254f46749e644bc01328c1
Prerequisites
- Authentication: Basic or OAuth authentication details
- Access group resource: Read and write permission on webhook resource group.
Resource information
| URL | /v3/webHooks/{webHookId} |
| HTTP method | DELETE |
| Pagination supported? | NA |
| Rate limit | NA |
| Batch support | NA |
Request parameters
| (Parameters marked with * are mandatory) | Type | Description |
|---|---|---|
| webHookId* | String | Identifier for the webhook. |
curl --location --request DELETE 'http://eu.api.capillarytech.com/v3/webHooks/69254f46749e644bc01328c1' \
--header 'Authorization: Basic ****' \
--header 'Cookie: _cfuvid=yYsH7ns18uvZ6yJ8YEDgIPw.ZjqHMYsSsHCnY00XLAM-1764052824812-0.0.1.1-604800000'Response parameters
| Parameter | Description |
|---|---|
| data | Contains main details about the webhook configuration. |
| -attribution | Metadata about the creation and last update of the webhook. |
| -- createdOn | Timestamp when the webhook was created. It is in the local time zone of the org and in ISO 8601 format. |
| -- lastUpdatedOn | Timestamp when the webhook was last updated. It is in the local time zone of the org and in ISO 8601 format. |
| -- lastUpdatedBy | Information about the user who last updated the webhook. |
| --- id | Unique identifier of the user. |
| --- code | Code of the user. |
| --- description | Description of the user. |
| --- name | Name of the user. |
| --- type | Type of user. Example: TILL |
| -- createdBy | Information about the user who created the webhook. |
| --- id | Unique identifier of the user. |
| --- code | Code of the user. |
| --- description | Description of the user. |
| --- name | Name of the user. |
| --- type | Type of user. Example: TILL |
| webHookId | Unique identifier of the webhook. |
| name | Name of the webhook. |
| eventNames | List of event names that trigger the webhook. |
| webHookUrl | URL where the webhook sends its requests. |
| webHookType | Type of webhook, Example: HTTP |
| methodType | HTTP method used by the webhook. Example: POST, PUT, GET or DELETE. |
| webHookHeaders | Headers sent with the webhook request. |
| -Authorization | Authorization header for authentication. |
| -Content-Type | Specifies the content, Example: application/json |
| noOfRetryAttempts | Number of retry attempts configured. |
| maxAllowedConnections | Maximum allowed concurrent connections for this webhook. |
| active | Indicates if the webhook is active. |
| slaInSeconds | Expected delivery time of the event notification in seconds. This is used to track notifications that took more time than the SLA set. |
| consumerGroupId | Identifier for the consumer group. |
| tillDetailsEnrichmentEnabled | Indicates if the event payload is enriched with till details. |
| storeDetailsEnrichmentEnabled | Indicates if the event payload is enriched with store details |
| customerIdentifiersToBeEnriched | List of customer identifiers enrichment available in the payload. |
| awardedReferenceEnrichmentEnabled | Indicates if the event payload is enriched with awarded reference ID . It is a unique identifier associated with each issued point or redemption transaction within the system. |
| availablePointsBalanceEnrichmentEnabled | Indicates if the event payload is enriched with the available points balance. |
| errors | Array containing errors, if any. |
| warnings | Array containing warnings, if any. |
Sample response
{
"data": {
"attribution": {
"createdOn": "2025-11-25T06:40:06.036+0000",
"createdOnISO": "2025-11-25T06:40:06Z",
"lastUpdatedOn": "2025-11-25T08:58:27.608+0000",
"lastUpdatedOnISO": "2025-11-25T08:58:27Z",
"lastUpdatedBy": {
"id": 75152722,
"code": "divya_doc",
"description": "",
"name": "divya_doc",
"type": "TILL"
},
"createdBy": {
"id": 75152722,
"code": "divya_doc",
"description": "",
"name": "divya_doc",
"type": "TILL"
}
},
"webHookId": "69254f46749e644bc01328c1",
"name": "All_Events_v3",
"eventNames": [
"loyaltyCustomerMerge",
"partnerProgramLinked",
"pointsExpired",
"customerAdded",
"transactionUpdated",
"groupUpdated",
"promisedToCurrentPointsConversion",
"pointsTransferredReceived",
"groupMemberRemoved",
"groupCreated",
"partnerProgramUpdated",
"pointsIssued",
"tierDowngradeReminder",
"pointsContributionToGroup",
"CouponRedeem",
"pointsExpiryReminder",
"partnerProgramDelinked",
"CouponIssue",
"tierRenewed",
"tierDowngraded",
"pointsTransferredInitiated",
"customerUpdated",
"tierUpgraded",
"rewardIssued",
"pointsExpiryChange",
"rewardUpdated",
"supplementaryMembershipExpiryReminder",
"singlePointsExpiryUpdated",
"issuedPointsReversed",
"redeemedPointsReversed"
],
"webHookUrl": "https://eo4qiclzg50n2q8.m.pipedream.net",
"webHookType": "HTTP",
"methodType": "PUT",
"webHookHeaders": {
"Authorization": "Basic Q2FwaWxsYXJ5OklVTmhjR2xzYkdGeWVVQTROekl5",
"Content-Type": "application/json"
},
"noOfRetryAttempts": 0,
"maxAllowedConnections": 10,
"active": false,
"slaInSeconds": 150,
"consumerGroupId": "b3bd2ff7-1525-46d0-b855-08bee77209fc",
"listenToChildEvents": false,
"tillDetailsEnrichmentEnabled": false,
"storeDetailsEnrichmentEnabled": false,
"customerIdentifiersToBeEnriched": [],
"awardedReferenceEnrichmentEnabled": false,
"availablePointsBalanceEnrichmentEnabled": false
},
"errors": null,
"warnings": null
}