Class Webhooks

Webhooks resource handler

Index

Constructors

Methods

count create delete get getDelivery list listDeliveries resendDelivery test update verifySignature

Constructors

constructor

new Webhooks(client): Webhooks
Parameters
- client: SapoClient
Returns Webhooks
- Defined in resources/webhooks.ts:16

Methods

count

count(params?): Promise<number>
Get webhook count
Parameters
- Optional params: Partial<WebhookListParams>
  Filter parameters
Returns Promise<number>
- Defined in resources/webhooks.ts:70

create

create(data): Promise<Webhook>
Create a new webhook
Parameters
- data: CreateWebhookData
  Webhook creation data
Returns Promise<Webhook>
- Defined in resources/webhooks.ts:39

delete

delete(id): Promise<void>
Delete a webhook
Parameters
- id: number
  Webhook ID
Returns Promise<void>
- Defined in resources/webhooks.ts:62

get

get(id): Promise<Webhook>
Get a single webhook
Parameters
- id: number
  Webhook ID
Returns Promise<Webhook>
- Defined in resources/webhooks.ts:30

getDelivery

getDelivery(webhookId, deliveryId): Promise<WebhookDelivery>
Get a single webhook delivery
Parameters
- webhookId: number
  Webhook ID
- deliveryId: number
  Delivery ID
Returns Promise<WebhookDelivery>
- Defined in resources/webhooks.ts:92

list

list(params?): Promise<PaginatedResponse<Webhook>>
List webhooks
Parameters
- Optional params: WebhookListParams
  Query parameters
Returns Promise<PaginatedResponse<Webhook>>
- Defined in resources/webhooks.ts:22

listDeliveries

listDeliveries(webhookId, params?): Promise<PaginatedResponse<WebhookDelivery>>
List webhook deliveries
Parameters
- webhookId: number
  Webhook ID
- Optional params: WebhookDeliveryListParams
  Query parameters
Returns Promise<PaginatedResponse<WebhookDelivery>>
- Defined in resources/webhooks.ts:80

resendDelivery

resendDelivery(webhookId, deliveryId): Promise<WebhookDelivery>
Re-send a webhook delivery
Parameters
- webhookId: number
  Webhook ID
- deliveryId: number
  Delivery ID
Returns Promise<WebhookDelivery>
- Defined in resources/webhooks.ts:104

test

test(id): Promise<void>
Test a webhook by sending a dummy data payload
Parameters
- id: number
  Webhook ID
Returns Promise<void>
- Defined in resources/webhooks.ts:115

update

update(id, data): Promise<Webhook>
Update a webhook
Parameters
- id: number
  Webhook ID
- data: Partial<CreateWebhookData>
  Webhook update data
Returns Promise<Webhook>
- Defined in resources/webhooks.ts:51

verifySignature

verifySignature(signature, body): boolean
Verify webhook signature
Parameters
- signature: string
  HMAC signature from webhook
- body: string
  Raw webhook request body
Returns boolean
- Defined in resources/webhooks.ts:124