Developers
Open Swarmhit
Smart APIRaw API
API referenceWebhooks
PATCH
/webhooks/{id}

JavaScript SDK: swarmhit.webhooks.update(webhookId, params)

Authorization

bearerAuth
AuthorizationBearer <token>

An API key created on the Access tokens page.

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Any subset of these fields.

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/webhooks/string" \  -H "Content-Type: application/json" \  -d '{    "enabled": false  }'
{  "data": {    "id": "string",    "url": "string",    "events": [      "string"    ],    "enabled": true,    "classifyReplies": true,    "secret": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "lastDeliveryAt": "2019-08-24T14:15:22Z",    "failureCount": 0,    "disabledReason": "string"  }}

Send a test delivery POST

**JavaScript SDK:** [`swarmhit.webhooks.test(webhookId)`](/smart-api/sdk/methods#webhooks) Fires a one-off `webhook.test` delivery and returns the result immediately. Does not retry or affect the endpoint's health counters.

Cancel a link POST

**JavaScript SDK:** [`swarmhit.whatsappAccounts.cancelLink(whatsappAccountId)`](/smart-api/sdk/methods#whatsappAccounts) Give up a link before the scan. A number that was linked before goes back to needing a scan.