Interface: WebhooksApi

The methods of Talkline.webhooks.

Methods

create()

create(body): Promise<WebhookEndpointWithSecret>;

POST /v1/webhooks: the answer carries the signing secret, which nothing shows again.

Parameters

Parameter	Type
body	CreateWebhookRequest

Returns

Promise<WebhookEndpointWithSecret>

---

deliveries()

deliveries(id, query?): Promise<Page<Delivery>>;

GET /v1/webhooks/{id}/deliveries, one page.

Parameters

Parameter	Type
id	string
query?	ListDeliveriesQuery

Returns

Promise<Page<Delivery>>

---

get()

get(id): Promise<WebhookEndpoint>;

GET /v1/webhooks/{id}.

Parameters

Parameter	Type
id	string

Returns

Promise<WebhookEndpoint>

---

iterate()

iterate(query?): AsyncIterable<WebhookEndpoint>;

GET /v1/webhooks, every page in turn.

Parameters

Parameter	Type
query?	Pageless<PageQuery>

Returns

AsyncIterable<WebhookEndpoint>

---

iterateDeliveries()

iterateDeliveries(id, query?): AsyncIterable<Delivery>;

GET /v1/webhooks/{id}/deliveries, every page in turn.

Parameters

Parameter	Type
id	string
query?	Pageless<ListDeliveriesQuery>

Returns

AsyncIterable<Delivery>

---

list()

list(query?): Promise<Page<WebhookEndpoint>>;

GET /v1/webhooks, one page.

Parameters

Parameter	Type
query?	PageQuery

Returns

Promise<Page<WebhookEndpoint>>

---

remove()

remove(id): Promise<void>;

DELETE /v1/webhooks/{id}.

Parameters

Parameter	Type
id	string

Returns

Promise<void>

---

rotateSecret()

rotateSecret(id): Promise<WebhookEndpointWithSecret>;

POST /v1/webhooks/{id}/secret: every attempt from now on is signed with the new secret, retries included. The answer carries it, and nothing shows it again.

Parameters

Parameter	Type
id	string

Returns

Promise<WebhookEndpointWithSecret>

---

update()

update(id, body): Promise<WebhookEndpoint>;

PATCH /v1/webhooks/{id}: status: 'active' resumes a paused or failing endpoint, and sends what it held.

Parameters

Parameter	Type
id	string
body	UpdateWebhookRequest

Returns

Promise<WebhookEndpoint>