@agorio/sdk • Docs
Class: WebhookServer
Constructors
new WebhookServer()
new WebhookServer(
options):WebhookServer
Parameters
• options: WebhookServerOptions = {}
Returns
Defined in
src/webhook/webhook-server.ts:36
Accessors
baseUrl
Get Signature
get baseUrl():
string
Get the base URL of the webhook server.
Returns
string
Defined in
src/webhook/webhook-server.ts:138
callbackUrl
Get Signature
get callbackUrl():
string
Get the callback URL that merchants should send webhooks to.
Returns
string
Defined in
src/webhook/webhook-server.ts:131
Methods
clearEvents()
clearEvents():
void
Clear the event log.
Returns
void
Defined in
src/webhook/webhook-server.ts:159
computeSignature()
computeSignature(
payload):string
Compute HMAC-SHA256 signature for a payload.
Parameters
• payload: string
Returns
string
Defined in
src/webhook/webhook-server.ts:166
getEvents()
getEvents():
WebhookEvent[]
Get all received events.
Returns
Defined in
src/webhook/webhook-server.ts:145
getOrderEvents()
getOrderEvents(
orderId):WebhookEvent[]
Get events for a specific order.
Parameters
• orderId: string
Returns
Defined in
src/webhook/webhook-server.ts:152
start()
start():
Promise<void>
Start the webhook server.
Returns
Promise<void>
Defined in
src/webhook/webhook-server.ts:46
stop()
stop():
Promise<void>
Stop the webhook server.
Returns
Promise<void>
Defined in
src/webhook/webhook-server.ts:114
verifySignature()
verifySignature(
payload,signature):boolean
Verify an HMAC-SHA256 signature for a payload.
Parameters
• payload: string
• signature: string
Returns
boolean
Defined in
src/webhook/webhook-server.ts:176