Delete a webhook subscription

POST/webhook/deleteSubscription

Authentication

Include your API key in the x-api-key header on every request.

Request body

webhookIdstringrequired

The ID of the webhook subscription to delete

Response · 200 Webhook subscription deleted successfully

dataobjectrequired

messagestringrequired

warningsArray<string>

string

Errors

400Invalid request. The request was malformed or missing required parameters.

TypeScript SDKts

import { SwshApiClient } from "@somewhere-somehow/swsh-public-api";

const client = new SwshApiClient({ apiKey: process.env.SWSH_API_KEY! });

const result = await client.webhook.deleteSubscription({
  webhookId: "33333333-3333-3333-3333-333333333333"
});

cURLbash

curl "https://public-api.joinswsh.com/webhook/deleteSubscription" \
  -X POST \
  -H "x-api-key: $SWSH_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "webhookId": "33333333-3333-3333-3333-333333333333"
  }'

Example response

{"data": {"message": "Success!"
},
"warnings": ["Example warning"
]
}