Atlassian: Get failed webhooks

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

Operation atlassian.getfailedwebhooks

Provider route: GET /{cloudId}/rest/api/3/webhook/failed. 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"]["getFailedWebhooks"]>[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.getFailedWebhooks(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.get_failed_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}$
`query`	object	Optional	Additional keys: not allowed
`query.maxResults`	integer	Optional	Format: int32
`query.after`	integer	Optional	Format: int64

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 Get failed webhooks — response body

Referenced models: Get failed webhooks — response body

Schemas

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

Policy, approvals and errors

SDK function policy ID: atlassian.getfailedwebhooks. Catalog operation: getfailedwebhooks. 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