Atlassian: Webhooks schemas
10 Atlassian schemas with complete fields and constraints.
← Webhooks operations · All schemas
Extend webhook life — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Container for a list of webhook IDs. Additional keys: not allowed |
webhookIds | array | Required within parent | A list of webhook IDs. |
webhookIds[] | integer | Each item | A list of webhook IDs. Format: int64 |
Extend webhook life — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The date the refreshed webhooks expire. |
expirationDate | JSON | Optional | |
expirationDate (anyOf 1) | JSON | Alternative | |
expirationDate (anyOf 1) (anyOf 1) | integer | Alternative | |
expirationDate (anyOf 1) (anyOf 2) | string | Alternative | |
expirationDate (anyOf 2) | null | Alternative |
Get dynamic webhooks for app — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A page of items. |
isLast | JSON | Optional | |
isLast (anyOf 1) | boolean | Alternative | Whether this is the last page. Read only: true |
isLast (anyOf 2) | null | Alternative | |
maxResults | JSON | Optional | |
maxResults (anyOf 1) | JSON | Alternative | |
maxResults (anyOf 1) (anyOf 1) | integer | Alternative | The maximum number of items that could be returned. Format: int32 Read only: true |
maxResults (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
maxResults (anyOf 2) | null | Alternative | |
nextPage | JSON | Optional | |
nextPage (anyOf 1) | string | Alternative | If there is another page of results, the URL of the next page. Format: uri Read only: true |
nextPage (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the page. Format: uri Read only: true |
self (anyOf 2) | null | Alternative | |
startAt | JSON | Optional | |
startAt (anyOf 1) | JSON | Alternative | |
startAt (anyOf 1) (anyOf 1) | integer | Alternative | The index of the first item returned. Format: int64 Read only: true |
startAt (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
startAt (anyOf 2) | null | Alternative | |
total | JSON | Optional | |
total (anyOf 1) | JSON | Alternative | |
total (anyOf 1) (anyOf 1) | integer | Alternative | The number of items returned. Format: int64 Read only: true |
total (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total (anyOf 2) | null | Alternative | |
values | JSON | Optional | |
values (anyOf 1) | array | Alternative | The list of items. Read only: true |
values (anyOf 1)[] | Model | Each item | Expand Get dynamic webhooks for app — response body — values The list of items item |
values (anyOf 2) | null | Alternative |
Referenced models: Get dynamic webhooks for app — response body — values The list of items item
Get dynamic webhooks for app — response body — values The list of items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A webhook. |
events | JSON | Optional | |
events (anyOf 1) | array | Alternative | The Jira events that trigger the webhook. |
events (anyOf 1)[] | string | Each item | Known values: jira:issue_created, jira:issue_updated, jira:issue_deleted, comment_created, comment_updated, comment_deleted, issue_property_set, issue_property_deleted, sprint_created, sprint_updated, sprint_closed, sprint_deleted, sprint_started, jira:version_released, jira:version_unreleased, jira:version_created, jira:version_moved, jira:version_updated, jira:version_merged, jira:version_deleted |
events (anyOf 2) | null | Alternative | |
expirationDate | JSON | Optional | |
expirationDate (anyOf 1) | JSON | Alternative | |
expirationDate (anyOf 1) (anyOf 1) | integer | Alternative | |
expirationDate (anyOf 1) (anyOf 2) | string | Alternative | |
expirationDate (anyOf 2) | null | Alternative | |
fieldIdsFilter | JSON | Optional | |
fieldIdsFilter (anyOf 1) | array | Alternative | A list of field IDs. When the issue changelog contains any of the fields, the webhook `jira:issue_updated` is sent. If this parameter is not present, the app is notified about all field updates. |
fieldIdsFilter (anyOf 1)[] | string | Each item | A list of field IDs. When the issue changelog contains any of the fields, the webhook <code>jira:issue_updated</code> is sent. If this parameter is not present, the app is notified about all field updates. |
fieldIdsFilter (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | JSON | Alternative | |
id (anyOf 1) (anyOf 1) | integer | Alternative | The ID of the webhook. Format: int64 |
id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id (anyOf 2) | null | Alternative | |
issuePropertyKeysFilter | JSON | Optional | |
issuePropertyKeysFilter (anyOf 1) | array | Alternative | A list of issue property keys. A change of those issue properties triggers the `issue_property_set` or `issue_property_deleted` webhooks. If this parameter is not present, the app is notified about all issue property updates. |
issuePropertyKeysFilter (anyOf 1)[] | string | Each item | A list of issue property keys. A change of those issue properties triggers the <code>issue_property_set</code> or <code>issue_property_deleted</code> webhooks. If this parameter is not present, the app is notified about all issue property updates. |
issuePropertyKeysFilter (anyOf 2) | null | Alternative | |
jqlFilter | JSON | Optional | |
jqlFilter (anyOf 1) | string | Alternative | The JQL filter that specifies which issues the webhook is sent for. |
jqlFilter (anyOf 2) | null | Alternative | |
url | JSON | Optional | |
url (anyOf 1) | string | Alternative | The URL that specifies where the webhooks are sent. |
url (anyOf 2) | null | Alternative |
Get failed webhooks — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A page of failed webhooks. |
maxResults | JSON | Optional | |
maxResults (anyOf 1) | JSON | Alternative | |
maxResults (anyOf 1) (anyOf 1) | integer | Alternative | The maximum number of items on the page. If the list of values is shorter than this number, then there are no more pages. Format: int32 |
maxResults (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
maxResults (anyOf 2) | null | Alternative | |
next | JSON | Optional | |
next (anyOf 1) | string | Alternative | The URL to the next page of results. Present only if the request returned at least one result.The next page may be empty at the time of receiving the response, but new failed webhooks may appear in time. You can save the URL to the next page and query for new results periodically (for example, every hour). Format: uri |
next (anyOf 2) | null | Alternative | |
values | JSON | Optional | |
values (anyOf 1) | array | Alternative | The list of webhooks. |
values (anyOf 1)[] | Model | Each item | Expand Get failed webhooks — response body — values The list of webhooks item |
values (anyOf 2) | null | Alternative |
Referenced models: Get failed webhooks — response body — values The list of webhooks item
Get failed webhooks — response body — values The list of webhooks item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details about a failed webhook. |
body | JSON | Optional | |
body (anyOf 1) | string | Alternative | The webhook body. |
body (anyOf 2) | null | Alternative | |
failureTime | JSON | Optional | |
failureTime (anyOf 1) | JSON | Alternative | |
failureTime (anyOf 1) (anyOf 1) | integer | Alternative | The time the webhook was added to the list of failed webhooks (that is, the time of the last failed retry). Format: int64 |
failureTime (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
failureTime (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The webhook ID, as sent in the `X-Atlassian-Webhook-Identifier` header with the webhook. |
id (anyOf 2) | null | Alternative | |
url | JSON | Optional | |
url (anyOf 1) | string | Alternative | The original webhook destination. |
url (anyOf 2) | null | Alternative |
Register dynamic webhooks — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of webhooks to register. Additional keys: not allowed |
url | string | Required within parent | The URL that specifies where to send the webhooks. This URL must use the same base URL as the Connect app. Only a single URL per app is allowed to be registered. |
webhooks | array | Required within parent | A list of webhooks. |
webhooks[] | Model | Each item | Expand Register dynamic webhooks — request body — body webhooks item |
Referenced models: Register dynamic webhooks — request body — body webhooks item
Register dynamic webhooks — request body — body webhooks item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A list of webhooks. Additional keys: not allowed |
events | array | Required within parent | The Jira events that trigger the webhook. |
events[] | string | Each item | One of: jira:issue_created, jira:issue_updated, jira:issue_deleted, comment_created, comment_updated, comment_deleted, issue_property_set, issue_property_deleted, sprint_created, sprint_updated, sprint_closed, sprint_deleted, sprint_started, jira:version_released, jira:version_unreleased, jira:version_created, jira:version_moved, jira:version_updated, jira:version_merged, jira:version_deleted |
fieldIdsFilter | array | Optional | A list of field IDs. When the issue changelog contains any of the fields, the webhook `jira:issue_updated` is sent. If this parameter is not present, the app is notified about all field updates. |
fieldIdsFilter[] | string | Each item | A list of field IDs. When the issue changelog contains any of the fields, the webhook <code>jira:issue_updated</code> is sent. If this parameter is not present, the app is notified about all field updates. |
issuePropertyKeysFilter | array | Optional | A list of issue property keys. A change of those issue properties triggers the `issue_property_set` or `issue_property_deleted` webhooks. If this parameter is not present, the app is notified about all issue property updates. |
issuePropertyKeysFilter[] | string | Each item | A list of issue property keys. A change of those issue properties triggers the <code>issue_property_set</code> or <code>issue_property_deleted</code> webhooks. If this parameter is not present, the app is notified about all issue property updates. |
jqlFilter | string | Required within parent | The JQL filter that specifies which issues the webhook is sent for. Only a subset of JQL can be used. The supported elements are: * Fields: `issueKey`, `project`, `issuetype`, `status`, `assignee`, `reporter`, `issue.property`, and `cf[id]`. For custom fields (`cf[id]`), only the epic label custom field is supported.". * Operators: `=`, `!=`, `IN`, and `NOT IN`. |
Register dynamic webhooks — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Container for a list of registered webhooks. Webhook details are returned in the same order as the request. |
webhookRegistrationResult | JSON | Optional | |
webhookRegistrationResult (anyOf 1) | array | Alternative | A list of registered webhooks. |
webhookRegistrationResult (anyOf 1)[] | Model | Each item | Expand Register dynamic webhooks — response body — webhook Registration Result A list of registered webhooks item |
webhookRegistrationResult (anyOf 2) | null | Alternative |
Referenced models: Register dynamic webhooks — response body — webhook Registration Result A list of registered webhooks item
Register dynamic webhooks — response body — webhook Registration Result A list of registered webhooks item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | ID of a registered webhook or error messages explaining why a webhook wasn't registered. |
createdWebhookId | JSON | Optional | |
createdWebhookId (anyOf 1) | JSON | Alternative | |
createdWebhookId (anyOf 1) (anyOf 1) | integer | Alternative | The ID of the webhook. Returned if the webhook is created. Format: int64 |
createdWebhookId (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
createdWebhookId (anyOf 2) | null | Alternative | |
errors | JSON | Optional | |
errors (anyOf 1) | array | Alternative | Error messages specifying why the webhook creation failed. |
errors (anyOf 1)[] | string | Each item | Error messages specifying why the webhook creation failed. |
errors (anyOf 2) | null | Alternative |