Forge migration events

Forge migration events are generated from your server to Forge app migration built on the app migration platform.

You can consume these events by invoking your Forge function using a trigger.

Events

You can add the following events to your Forge trigger.

Event	Description
`avi:ecosystem.migration:triggered:listener`	Your server app migration listener has been triggered.
`avi:ecosystem.migration:uploaded:app_data`	Your server app uploaded app data.
`avi:ecosystem.migration:requested:transfer_cancellation`	The user has cancelled a transfer.
`avi:ecosystem.migration:errored:listener`	An unhandled exception ocurred in your server app migration listener.
`avi:ecosystem.migration:completed:export_phase`	`completeExport()` has been called in your server app to signal to your Forge app that all app data has been uploaded
`avi:ecosystem.migration:settled:transfer`	The app migration platform has settled the transfer.

Payload

This is the data that is passed to your Forge function when it is invoked.

Attribute	Type	Description
`eventType`	`string`	The migration event type.
`transferId`	`string`	An ID (UUID) that the app migration platform uniquely generates per migration.
`migrationDetails.migrationId`	`string`	An ID (UUID) that the app migration platform uses to uniquely identify a migration.
`migrationDetails.migrationScopeId`	`string`	An ID that the app migration platform generates to uniquely determine a source (server) and destination (cloud-site) of migration.
`migrationDetails.createdAt`	`number`	Timestamp of when the app migration was created.
`migrationDetails.cloudUrl`	`string`	URL of the destination cloud site for the migration.
`migrationDetails.name`	`string`	The name of the migration plan provided by the user who initiated the migration.
`key`	`string`	An ID (UUID) to uniquely identify the data your server app uploads to cloud storage. This will only be present on `avi:ecosystem.migration:uploaded:app_data` events.
`label`	`string \| undefined`	Metadata that provides additional information about the data your server app uploads to cloud storage. This will only be present on `avi:ecosystem.migration:uploaded:app_data` events.
`messageId`	`string`	An ID (UUID) that the app migration platform generates to uniquely recognise an event.
`transferError.exceptionType`	`string \| undefined`	Metadata that provides details of the exception type that occurs when executing server side listener method (`onStartAppMigration`). This will only be present on `avi:ecosystem.migration:errored:listener` events.
`transferError.safeStackTrace`	`string \| undefined`	Metadata that provides the stack trace of error that occurs when executing server side listener method (`onStartAppMigration`). This will only be present on `avi:ecosystem.migration:errored:listener` events.

Example payload

1
2
{
  "eventType": "avi:ecosystem.migration:uploaded:app_data",
  "transferId": "3f3a47f2-a6a2-4204-84bb-d0fc504c9dc6",
  "migrationDetails": {
    "migrationId": "403c4f71-a0d1-4a63-97a8-487d18691c46",
    "migrationScopeId": "0ba07dd9-3804-4600-9102-fa6e1efeab08",
    "createdAt": 1723111376499,
    "cloudUrl": "https://your-customer-cloud-site.atlassian.net",
    "name": "Migration Plan Name"
  },
  "key": "e094ca53-3747-4541-b263-0bf7b56a5bca",
  "label": "file-label-you-used",
  "serverAppVersion": "1.0",
  "messageId": "53f88ea7-a2d2-4dd2-9f36-2d8c43401b11"
}