Moonborn — API · webhooks

Archive a webhook endpoint (soft; pending deliveries are dead-lettered)

Soft-archive: status flips to `archived`, in-flight deliveries are dead-lettered, pending deliveries are cancelled. Audit history is retained. Use this rather than waiting for status update.

DELETE/v1/webhooks/{id}scope · Bearer (API key or session JWT)

Path parameters

Field	Type	Description
idreq	string	Webhook endpoint id (e.g. `whe_*`).

Responses

204Archived (no content)

401Unauthenticated

Body

Field	Type	Description
errorreq	object
error.codereq	string
error.messagereq	string

404Endpoint not found

Body

Field	Type	Description
errorreq	object
error.codereq	string
error.messagereq	string

Examples

cURL

curl -X DELETE https://api.moonborn.co/v1/webhooks/<id> \
  -H "Authorization: Bearer $MOONBORN_API_KEY"

TypeScript

import Moonborn from '@moonborn/sdk';

const client = new Moonborn({ apiKey: process.env.MOONBORN_API_KEY });

const result = await client.webhooks.archiveWebhookEndpoint({
  id: '<id>',
});

Python

import os
from moonborn import Moonborn

client = Moonborn(api_key=os.environ["MOONBORN_API_KEY"])

result = client.webhooks.archive_webhook_endpoint(
    id="<id>",
)