Notification API

Postman Collection

OpenAPI

Provides endpoints to register/deregister your cloud app, and to receive notifications about migration events

Operations

GET/webhook PUT/webhook

GET

Get all webhooks

Retrieves all the webhook endpoints for a cloud site

Request

This request has no parameters.

Responses

OK

application/json

WebhookEndpointsDto

GET/webhook

curl

Node.js

Java

Python

PHP

1
2
3

curl --request GET \
  --url 'https://your-site.atlassian.net/rest/atlassian-connect/1/migration/webhook' \
  --header 'Accept: application/json'

200Response

{
  "endpoints": [
    "<string>"
  ]
}

PUT

Update webhook

Replaces existing URLs with a new set of URLs provided by your cloud app to receive notifications

Request

Request bodyapplication/json

Set of endpoints called after the app migration

endpoints

array<string>

Responses

OK

PUT/webhook

curl

Node.js

Java

Python

PHP

curl --request PUT \
  --url 'https://your-site.atlassian.net/rest/atlassian-connect/1/migration/webhook' \
  --header 'Content-Type: application/json' \
  --data '{
  "endpoints": [
    "<string>"
  ]
}'