fastify-x-signwell
xsignwell.webhooks.create
Register a new SignWell webhook endpoint to receive event notifications at a public URL.
xsignwell.webhooks.create
Register a webhook endpoint with SignWell. SignWell will POST event payloads to callbackUrl when matching events occur.
Signature
fastify.xsignwell.webhooks.create(params: {
callbackUrl: string;
event?: string;
}): Promise<Object>
Params
| Name | Type | Required | Description |
|---|---|---|---|
params.callbackUrl | string | Yes | Public URL that SignWell will POST events to. |
params.event | string | No | Event type to subscribe to. Omit to receive all events. Use webhooks.events constants. |
Returns
Created webhook object with id, callback_url, and event.
Throws
[xSignwell] webhooks.create: params object is required[xSignwell] webhooks.create: callbackUrl (string) is required- Re-throws SignWell API errors with
statusCodeandsignwellErrorproperties.
Examples
Register a webhook for a specific event
const webhook = await fastify.xsignwell.webhooks.create({
callbackUrl: "https://api.example.com/webhooks/signwell",
event: fastify.xsignwell.webhooks.events.DOCUMENT_COMPLETED,
});
console.log(webhook.id); // "hook_abc123"
Register for all events
const webhook = await fastify.xsignwell.webhooks.create({
callbackUrl: "https://api.example.com/webhooks/signwell",
});
See also
- webhooks.list — list all registered webhook endpoints
- webhooks.delete — remove a registered webhook
- webhooks.verifySignature — verify HMAC signature on incoming events
- webhooks.parseEvent — parse an incoming event payload
AI Context
package: "@xenterprises/fastify-xsignwell"
method: fastify.xsignwell.webhooks.create(params)
use-when: Register a new SignWell webhook endpoint to receive event notifications at a public URL
params: callbackUrl (string, required), event (string, optional — use webhooks.events constants)
returns: webhook object with id, callback_url, event