Module webhooks_api

Enums

DeleteWebhookByIdError

struct for typed errors of method delete_webhook_by_id

GetDynamicWebhooksForAppError

struct for typed errors of method get_dynamic_webhooks_for_app

GetFailedWebhooksError

struct for typed errors of method get_failed_webhooks

RefreshWebhooksError

struct for typed errors of method refresh_webhooks

RegisterDynamicWebhooksError

struct for typed errors of method register_dynamic_webhooks

Functions

delete_webhook_by_id

Removes webhooks by ID. Only webhooks registered by the calling Connect app are removed. If webhooks created by other apps are specified, they are ignored. Permissions required: Only Connect apps can use this operation.

get_dynamic_webhooks_for_app

Returns a paginated list of the webhooks registered by the calling app. Permissions required: Only Connect apps can use this operation.

get_failed_webhooks

Returns webhooks that have recently failed to be delivered to the requesting app after the maximum number of retries. After 72 hours the failure may no longer be returned by this operation. The oldest failure is returned first. This method uses a cursor-based pagination. To request the next page use the failure time of the last webhook on the list as the failedAfter value or use the URL provided in next. Permissions required: Only Connect apps can use this operation.

refresh_webhooks

Webhooks registered through the REST API expire after 30 days. Call this resource periodically to keep them alive. Unrecognized webhook IDs (nonexistent or belonging to other apps) are ignored. Permissions required: Only Connect apps can use this operation.

register_dynamic_webhooks

Registers webhooks. Permissions required: Only Connect apps can use this operation.