Webhooks

Get dynamic webhooks for app

Changed on

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

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/rest/api/3/webhook
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: read:jira-work, manage:jira-webhook

Query parameters

startAtinteger

The index of the first item to return in a page of results (page offset).

maxResultsinteger

The maximum number of items to return per page.

Response

Returned if the request is successful.

isLastboolean

Whether this is the last page.

maxResultsinteger

The maximum number of items that could be returned.

nextPagestring uri

If there is another page of results, the URL of the next page.

selfstring uri

The URL of the page.

startAtinteger

The index of the first item returned.

totalinteger

The number of items returned.

Changes

  • 5021849ab549Revision changes
    • warning

      added the new jira:version_created enum value to the /// response property for the response status

    • warning

      added the new jira:version_deleted enum value to the /// response property for the response status

    • warning

      added the new jira:version_merged enum value to the /// response property for the response status

    • warning

      added the new jira:version_moved enum value to the /// response property for the response status

    • warning

      added the new jira:version_released enum value to the /// response property for the response status

    • warning

      added the new jira:version_unreleased enum value to the /// response property for the response status

    • warning

      added the new jira:version_updated enum value to the /// response property for the response status

    • warning

      added the new sprint_closed enum value to the /// response property for the response status

    • warning

      added the new sprint_created enum value to the /// response property for the response status

    • warning

      added the new sprint_deleted enum value to the /// response property for the response status

    • warning

      added the new sprint_started enum value to the /// response property for the response status

    • warning

      added the new sprint_updated enum value to the /// response property for the response status

  • 52016d857365Revision changes
    • info

      added the required property // to the response with the status