When integrating with a Cyclr Marketplace you can specify a Webhook URL for Cyclr to send notifications to after your users have performed a Marketplace action.

Setting Marketplace URL

In the Cyclr Console goto Embedding > Marketplace and select the Settings Cog. Set the Marketplace Notification URL to the location where Cyclr should send notifications.

Marketplace Notification URL

Installed Payload Example

 {
    "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"
}

Uninstalled Payload Example

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

Started Payload Example

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

Stopped Payload Example

 {
    "Status": "stopped",
    "AccountId": "00000000-0000-0000-0000-000000000000",
    "AccountApiId": "ExampleAccount",
    "MarketplaceIntegrationPackageId": 1234
}
Tags:
Edit me