App Data Migration Developer

App Data Migration Developer

Rate this page:

Notification API

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

Disclaimer: Atlassian Connect Resource. Replace the product-specific-path with the corresponding product API i.e.,

  • your-site.atlassian.net/wiki/rest/atlassian-connect/1/migration/ for Confluence
  • your-site.atlassian.net/rest/atlassian-connect/1/migration/ for Jira

Get all webhooks

GET /migration/webhook

Retrieves all the webhook endpoints for a cloud id

Request

There are no parameters for this request.

Example

1
2
3
curl --request GET \
  --url 'https://product-specific-path/migration/webhook' \
  --header 'Accept: application/json'

Responses

OK

Content typeValue
application/json

WebhookEndpointsDto

Update webhook

PUT /migration/webhook

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

Request

Body parameters
endpoints

Array<string>

Non empty JSON array of absolute URL(s)

Example

1
2
3
4
5
6
7
8
curl --request PUT \
  --url 'https://product-specific-path/migration/webhook' \
  --header 'Content-Type: application/json' \
  --data '{
  "endpoints": [
    "<string>"
  ]
}'

Responses

OK

A schema has not been defined for this response code.

Delete webhook

POST /migration/webhook/delete

Deletes webhook endpoints for a cloud id. This feature will be deprecated on 18 November 2020. Read the notice of deprecation for this feature.

Request

Body parameters
endpoints

Array<string>

Non empty JSON array of absolute URL(s)

Example

1
2
3
4
5
6
7
8
curl --request POST \
  --url 'https://product-specific-path/migration/webhook/delete' \
  --header 'Content-Type: application/json' \
  --data '{
  "endpoints": [
    "<string>"
  ]
}'

Responses

OK

A schema has not been defined for this response code.

Rate this page: