Marketplace Webhook Callback

When using Cyclr Marketplaces, you can specify a URL for Cyclr to send notifications to when the following events happen:

• a user installs an Integration Package.
• a user uninstalls an Integration Package.
• a user starts an Integration Package – which starts all of its related Cycles.
• a user stops an Integration Package – which stops all of its related Cycles.

Each Marketplace has a setting to configure where Cyclr sends those notifications:

1. In the Cyclr Console, select Embedding > Marketplaces.
2. Select View More for the appropriate Marketplace, then Settings.
3. Select Marketplace Settings.
4. In the Marketplace Notification URL box, enter a URL to receive notifications from Cyclr.

Example Webhook Notifications #

Installed payload #

{
    "Status": "installed",
    "AccountId": "00000000-0000-0000-0000-000000000000",
    "AccountApiId": "ExampleAccount",
    "MarketplaceIntegrationPackageId": 1234,
    "MarketplaceInstallDetails": [
        {
            "CycleId": "00000000-0000-0000-0000-000000000000",
            "CycleStatus": "Active",
            "Webhooks": [
                {
                    "Url": "https://example.com/api/webhook/abcdefg",
                    "StepName": "Example Webhook"
                }
            ],
            "TemplateId": "00000000-0000-0000-0000-000000000000",
            "TemplateReleaseId": "00000000-0000-0000-0000-000000000000"
        }
    ],
    "Errors" : ["Failed to start cycle"],
    "UserId": "00000000-0000-0000-0000-000000000000",
    "CompleteParameter": "example"
}

Uninstalled payload #

{
    "Status": "uninstalled",
    "AccountId": "00000000-0000-0000-0000-000000000000",
    "AccountApiId": "ExampleAccount",
    "MarketplaceIntegrationPackageId": 1234,
    "CompleteParameter": "example"
}

Started payload #

{
    "Status": "started",
    "AccountId": "00000000-0000-0000-0000-000000000000",
    "AccountApiId": "ExampleAccount",
    "MarketplaceIntegrationPackageId": 1234,
    "CompleteParameter": "example"
}

Stopped payload #

{
	"Status": "stopped",
	"AccountId": "00000000-0000-0000-0000-000000000000",
	"AccountApiId": "ExampleAccount",
	"MarketplaceIntegrationPackageId": 1234,
	"CompleteParameter": "example"
}