Atlassian: Register dynamic webhooks

Atlassian webhooks.registerDynamicWebhooks: arguments, response, policy and SDK examples.

Operation atlassian.registerdynamicwebhooks

Provider route: POST /{cloudId}/rest/api/3/webhook. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/atlassian with npm, or alter-sdk-atlassian with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { AtlassianIntegration } from "@alter-ai/atlassian";

async function execute(input: Parameters<AtlassianIntegration["webhooks"]["registerDynamicWebhooks"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new AtlassianIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.webhooks.registerDynamicWebhooks(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_atlassian import AtlassianIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = AtlassianIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.webhooks.register_dynamic_webhooks(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`path`	object	Required within parent	Additional keys: not allowed
`path.cloudId`	string	Required within parent	Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
`body`	Model	Required within parent	Expand Register dynamic webhooks — request body — body

Referenced models: Register dynamic webhooks — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	Model	Root	Expand Register dynamic webhooks — response body

Referenced models: Register dynamic webhooks — response body

Schemas

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

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

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

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`.

Policy, approvals and errors

SDK function policy ID: atlassian.registerdynamicwebhooks. Catalog operation: registerdynamicwebhooks. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["manage:jira-webhook", "read:jira-work"]

Official provider source

Report an issue with this page