Events

This page explains the events of the App migration platform. Registering webhooks allows your cloud app to receive notifications about migration events.

Events are HTTP POST requests to endpoints previously registered by your app. Responses should be a HTTP success message (HTTP 2**) sent within 10 seconds of receiving the event. If the request times-out, or if the response code does not represent success, the event will be retried.

Types of events

The App migration platform provides notifications to your cloud app using the following event types:

Event type	Description
`listener-triggered`	Notifies your cloud app when core product data migration is complete or incomplete. The App migration platform will not notify your cloud app if core product data migration fails.
`app-data-uploaded`	Notifies your cloud app that app data upload to the the Atlassian secure cloud storage is complete.

The App migration platform may notify your cloud app about events in a different order to the list above. app-data-uploaded may appear before listener-triggered event notifications.

Definitions of event attributes

This section provides information you can use to interpret events.

Event attribute	Definition	Examples of application
`eventType`	Specifies the event type.	Your cloud app can respond with a request, based on the event type it receives. For example, it can make a query for mappings.
`cloudAppKey`	The app key installed app key in the cloud site.	NA
`transferId`	An ID (UUID) that the App migration platform uniquely generates per migration for each listener.	Your cloud app must include this UUID when making a request for migration-related mappings.
`messageId`	An ID (UUID) that the App migration platform generates to uniquely recognise an event.	The App migration platform may send duplicate notifications for the same event. Use this ID to detect duplication, if your app is sensitive to duplicate notifications.
`migrationId`	An ID (UUID) that the App migration platform uses to uniquely identify a migration.	NA
`migrationScopeId`	An ID that the App migration platform generates to uniquely determine a source (server) and destination (cloud-site) of migration.	NA
`name`	The name of the migration plan provided by the user who initiated the migration.	Use this as a quick way to identify a migration while troubleshooting.
`createdAt`	Timestamp of when the app migration was created.	NA
`jiraClientKey`	This is the `clientKey` of the Jira product tenant, present in the `installed` lifecycle callback sent to your cloud application during installation.	This value is 'unknown' when the Jira product is not involved in the migration.
`confluenceClientKey`	This is the `clientKey` of the Confluence product tenant, present in the `installed` lifecycle callback sent to your cloud application during installation.	This value is 'unknown' when the Confluence product is not involved in the migration.
`cloudUrl`	URL of the destination cloud site for the migration.	Use this URL to upload/modify data related to your app migration.
`s3Key`	An ID (UUID) that the App migration platform generates to uniquely identify the data your server app uploads to cloud storage.	Your cloud app must use this ID to request access to ID-specific data in cloud storage.
`label`	Metadata that provides additional information about the data your server app uploads to cloud storage.	NA

JSON representation of event object

Confluence migration event object

{
    "eventType": "listener-triggered",
    "cloudAppKey": "my-cloud-app-key",
    "transferId": "e4166374-2345-4c31-918c-83b14eb644f6",
    "migrationDetails": {
        "migrationId": "8e60dc59-78d6-484f-966a-a09ff8be8ed0",
        "migrationScopeId": "442bdd69-622d-323d-889d-383b41d8e536",
        "name": "Migration of my Confluence page",
        "createdAt": 1597211035,
        "jiraClientKey": "unknown",
        "confluenceClientKey": "03a7cb4b-23b6-3a79-8916-8824a053e786",
        "cloudUrl": "https://cloud-site-under-migration.atlassian.net"
    }
}

Jira migration event object

{
    "eventType": "app-data-uploaded",
    "cloudAppKey": "my-cloud-app-key",
    "transferId": "16a84eaa-3f88-4758-94d4-ea245a3b202f",
    "migrationDetails": {
        "migrationId": "a0b8ed5a-a335-4e0d-b20f-17d821b40c2d",
        "migrationScopeId": "47d54f22-0b9d-4cda-a527-c65ef65f2564",
        "name": "Migration of my jira project",
        "createdAt": 1597193662,
        "jiraClientKey": "acb711b8-a878-356e-abbf-1ae1730308a2",
        "confluenceClientKey": "unknown",
        "cloudUrl": "https://cloud-site-under-migration.atlassian.net"
    },
    "s3Key": "636abf0f-38a2-45c1-8c68-9c7edde97f3f",
    "label": "some-optional-label"
}