definitions.Interfaces.IWebHooksClient.md

mailgun.js / Modules / definitions / Interfaces / IWebHooksClient

Interface: IWebHooksClient

definitions.Interfaces.IWebHooksClient

Table of contents

Methods

• create
• destroy
• get
• list
• update

Methods

create

▸ create(domain, id, url, test): Promise<WebhookValidationResponse | WebhookResult>

Parameters

Name	Type
domain	string
id	string
url	string
test	boolean

Returns

Promise<WebhookValidationResponse | WebhookResult>

Defined in

Interfaces/Webhooks/IWebHooksClient.ts:14

---

destroy

▸ destroy(domain, id): Promise<WebhookResult>

Parameters

Name	Type
domain	string
id	string

Returns

Promise<WebhookResult>

Defined in

Interfaces/Webhooks/IWebHooksClient.ts:20

---

get

▸ get(domain, id): Promise<WebhookResult>

Parameters

Name	Type
domain	string
id	WebhooksIds

Returns

Promise<WebhookResult>

Defined in

Interfaces/Webhooks/IWebHooksClient.ts:13

---

list

▸ list(domain, query): Promise<WebhookList>

Parameters

Name	Type
domain	string
query	WebhooksQuery

Returns

Promise<WebhookList>

Defined in

Interfaces/Webhooks/IWebHooksClient.ts:12

---

update

▸ update(domain, id, url): Promise<WebhookResult>

Parameters

Name	Type
domain	string
id	string
url	string | string[]

Returns

Promise<WebhookResult>

Defined in

Interfaces/Webhooks/IWebHooksClient.ts:19