Webhooks | @tillhub/javascript-sdk

Hierarchy

ThBaseHandler
- Webhooks

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Webhooks(options: WebhooksOptions, http: Client): Webhooks

Overrides ThBaseHandler.constructor
- Defined in src/v0/webhooks.ts:41
Parameters
- options: WebhooksOptions
- http: Client
Returns Webhooks

Properties

endpoint

endpoint: string

http

http: Client

options

options: WebhooksOptions

uriHelper

uriHelper: UriHelper

Static baseEndpoint

baseEndpoint: string = '/api/v0/webhooks'

Methods

create

create(webhook: Webhook): Promise<WebhookResponse>

- Defined in src/v0/webhooks.ts:100
Parameters
- webhook: Webhook
Returns Promise<WebhookResponse>

delete

delete(webhookId: string): Promise<WebhookResponse>

- Defined in src/v0/webhooks.ts:139
Parameters
- webhookId: string
Returns Promise<WebhookResponse>

get

get(webhookId: string): Promise<WebhookResponse>

- Defined in src/v0/webhooks.ts:82
Parameters
- webhookId: string
Returns Promise<WebhookResponse>

getAll

getAll(query?: WebhookQuery): Promise<WebhookResponse>

- Defined in src/v0/webhooks.ts:56
Parameters
- Optional query: WebhookQuery
Returns Promise<WebhookResponse>

put

put(webhookId: string, webhook: Webhook): Promise<WebhookResponse>

- Defined in src/v0/webhooks.ts:119
Parameters
- webhookId: string
- webhook: Webhook
Returns Promise<WebhookResponse>

Generated using TypeDoc