Type Alias WebhooksAPI

type WebhooksAPI = {
    clearCache: typeof clearCache;
    createWebhook: typeof createWebhook;
    deleteWebhook: typeof deleteWebhook;
    getWebhook: typeof getWebhook;
    getWebhookDeliveries: typeof getWebhookDeliveries;
    getWebhookDelivery: typeof getWebhookDelivery;
    getWebhookEventTypes: typeof getWebhookEventTypes;
    getWebhooks: typeof getWebhooks;
    patchWebhook: typeof patchWebhook;
    resendWebhookDelivery: typeof resendWebhookDelivery;
    updateWebhook: typeof updateWebhook;
}
Index

Properties

clearCache createWebhook deleteWebhook getWebhook getWebhookDeliveries getWebhookDelivery getWebhookEventTypes getWebhooks patchWebhook resendWebhookDelivery updateWebhook

Properties

clearCache: typeof clearCache

Clears the cache for webhooks api requests.

createWebhook: typeof createWebhook

Creates a new webhook. User must be assigned the TenantAdmin role to create tenant level webhooks.

Param: body

an object with the body content

CreateWebhookHttpError

deleteWebhook: typeof deleteWebhook

Deletes a specific webhook.

The webhook's unique identifier.

DeleteWebhookHttpError

getWebhook: typeof getWebhook

Returns details for a specific webhook.

The webhook's unique identifier.

GetWebhookHttpError

getWebhookDeliveries: typeof getWebhookDeliveries

Returns deliveries for a specific webhook. Delivery history is stored for 1 week.

The webhook's unique identifier.

an object with query parameters

GetWebhookDeliveriesHttpError

getWebhookDelivery: typeof getWebhookDelivery

Returns details for a specific delivery.

The webhook's unique identifier.

The delivery's unique identifier.

GetWebhookDeliveryHttpError

getWebhookEventTypes: typeof getWebhookEventTypes

Lists event-types that are possible to subscribe to.

GetWebhookEventTypesHttpError

getWebhooks: typeof getWebhooks

Retrieves all webhooks entries for a tenant that the user has access to. Users assigned the TenantAdmin role can retrieve all webhooks. A user can have up to 150 webhooks at one time.

an object with query parameters

GetWebhooksHttpError

patchWebhook: typeof patchWebhook

Patches a webhook to update one or more properties.

The webhook's unique identifier.

Param: body

an object with the body content

PatchWebhookHttpError

resendWebhookDelivery: typeof resendWebhookDelivery

Resends the delivery with the same payload.

The webhook's unique identifier.

The delivery's unique identifier.

ResendWebhookDeliveryHttpError

updateWebhook: typeof updateWebhook

Updates a webhook, any omitted fields will be cleared, returns updated webhook.

The webhook's unique identifier.

Param: body

an object with the body content

UpdateWebhookHttpError

Settings

Member Visibility

On This Page

Properties