Function: getWebhookField()
ts
function getWebhookField<T>(client, parameters): Promise<FieldValue<T>>;Defined in: api/webhooks.ts:70
Get a field on a Webhook
Type Parameters
| Type Parameter | Default type |
|---|---|
T | unknown |
Parameters
| Parameter | Type | Description |
|---|---|---|
client | Client | - |
parameters | { field: | "active" | "description" | "idModel" | "callbackURL" | "consecutiveFailures" | "firstConsecutiveFailDate"; id: unknown; } | - |
parameters.field | | "active" | "description" | "idModel" | "callbackURL" | "consecutiveFailures" | "firstConsecutiveFailDate" | Field to retrieve. One of: active, callbackURL, description, idModel |
parameters.id | unknown | ID of the webhook. |
Returns
Promise<FieldValue<T>>