webhook

delete-by-id

Delete webhooks by ID

Removes webhooks by ID. Only webhooks registered by the calling app are removed. If webhooks created by other apps are specified, they are ignored.

Permissions required: Only Connect and OAuth 2.0 apps can use this operation.

DELETE /rest/api/3/webhook

Flag	Type	Required	Description
--body	string	No	request body (JSON string, @file, or - for stdin)

Example:

jr webhook delete-by-id

get-dynamic-webhooks-for-app

Get dynamic webhooks for app

Returns a paginated list of the webhooks registered by the calling app.

Permissions required: Only Connect and OAuth 2.0 apps can use this operation.

GET /rest/api/3/webhook

Flag	Type	Required	Description
--maxResults	string	No	The maximum number of items to return per page.
--startAt	string	No	The index of the first item to return in a page of results (page offset).

Example:

jr webhook get-dynamic-webhooks-for-app

get-failed

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.

GET /rest/api/3/webhook/failed

Flag	Type	Required	Description
--after	string	No	The time after which any webhook failure must have occurred for the record to be returned, expressed as milliseconds since the UNIX epoch.
--maxResults	string	No	The maximum number of webhooks to return per page. If obeying the maxResults directive would result in records with the same failure time being split across pages, the directive is ignored and all records with the same failure time included on the page.

Example:

jr webhook get-failed

refresh

Extend webhook life

Extends the life of webhook. Webhooks registered through the REST API expire after 30 days. Call this operation to keep them alive.

Unrecognized webhook IDs (those that are not found or belong to other apps) are ignored.

Permissions required: Only Connect and OAuth 2.0 apps can use this operation.

PUT /rest/api/3/webhook/refresh

Flag	Type	Required	Description
--body	string	No	request body (JSON string, @file, or - for stdin)

Example:

jr webhook refresh

register-dynamic

Register dynamic webhooks

Registers webhooks.

NOTE: for non-public OAuth apps, webhooks are delivered only if there is a match between the app owner and the user who registered a dynamic webhook.

Permissions required: Only Connect and OAuth 2.0 apps can use this operation.

POST /rest/api/3/webhook

Flag	Type	Required	Description
--body	string	No	request body (JSON string, @file, or - for stdin)

Example:

jr webhook register-dynamic