fastify-x-signwell
xsignwell.webhooks.delete
Remove a registered SignWell webhook endpoint by ID.
xsignwell.webhooks.delete
Delete a registered webhook endpoint. webhooks.remove is an alias for this method.
Signature
fastify.xsignwell.webhooks.delete(webhookId: string): Promise<Object>
// remove is an alias for delete
Params
| Name | Type | Required | Description |
|---|---|---|---|
webhookId | string | Yes | ID of the webhook to delete. |
Returns
API response for the delete operation.
Throws
[xSignwell] webhooks.remove: webhookId (string) is required- Re-throws SignWell API errors with
statusCodeandsignwellErrorproperties.
Examples
Delete a webhook by ID
await fastify.xsignwell.webhooks.delete("hook_abc123");
Using the remove alias
await fastify.xsignwell.webhooks.remove("hook_abc123");
See also
- webhooks.list — list all registered webhooks to find IDs
- webhooks.create — register a new webhook endpoint
AI Context
package: "@xenterprises/fastify-xsignwell"
method: fastify.xsignwell.webhooks.delete(webhookId)
use-when: Remove a registered SignWell webhook endpoint by its ID; remove is an alias
params: webhookId (string, required)
returns: API response for the delete operation