Delete a webhook subscription

Deletes a webhook subscription.

POST /api/service/webhook-subscription/delete

JavaScript

JavaScript

import Ivy from '@getivy/node-sdk';

const client = new Ivy({
  apiKey: process.env['IVY_API_KEY'], // This is the default and can be omitted
});

const subscription = await client.webhook.subscription.delete({ id: {} });

console.log(subscription.success);

200

{
  "success": true
}

Authorizations

X-Ivy-Api-Key · string · header · required

API key for authentication

Headers

Idempotency-Key · string

Idempotency key for safe retries. Reusing a key with an identical request body returns the cached response. Reusing a key with a different body returns 409.

Body

application/json

id · any · required

The unique identifier of the webhook subscription to delete

Response

200 - application/json

Returns success if deleted, an error otherwise.

success · boolean · required

Whether the webhook subscription was successfully deleted