Skip to main content

Schemas for notifications (1.0.0)

Download OpenAPI specification:Download

Use the notifications to notify the system of your choice of certain changes that happened in your Application.

Campaign created Webhook

Request Body schema: application/json

The notification indicating a campaign was created.

campaign
required
string
Enum: "expired" "scheduled" "running" "draft" "disabled"

A campaign state described exactly as in the Campaign Manager.

required
object

The campaign priority.

ruleset
string

The current ruleset.

Request samples

Content type
application/json
{
  • "campaign": "running",
  • "ruleset": {
    },
  • "priority": {
    }
}

Campaign state changed Webhook

Request Body schema: application/json

The notification indicating the state of a campaign changed.

required
object

The campaign whose state changed.

newState
required
string

The campaign's new state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'draft', 'archived']

oldState
required
string

The campaign's old state. Can be one of the following: ['running', 'disabled', 'scheduled', 'expired', 'draft', 'archived']

ruleset
string

The current ruleset.

Request samples

Content type
application/json
{
  • "campaign": {
    },
  • "ruleset": {
    },
  • "oldState": "string",
  • "newState": "string"
}

Campaign rules changed Webhook

Request Body schema: application/json

The notification indicating the rules of a campaign changed.

required
object

The current version of the campaign.

ruleset
required
string

The current ruleset.

oldRuleset
string

The old ruleset, if the ruleset was changed.

Request samples

Content type
application/json
{
  • "campaign": {
    },
  • "oldRuleset": {
    },
  • "ruleset": {
    }
}

Campaign edited Webhook

Request Body schema: application/json

The notification indicating a campaign was edited.

required
object

The current version of the campaign.

required
object

The campaign before it was edited.

ruleset
string

The current ruleset.

Request samples

Content type
application/json
{
  • "campaign": {
    },
  • "oldCampaign": {
    },
  • "ruleset": {
    }
}

Campaign deleted Webhook

Request Body schema: application/json

The notification indicating a campaign was deleted.

required
object

The current version of the campaign.

deletedAt
required
string <date-time>

Time when the campaign was deleted.

Request samples

Content type
application/json
{
  • "campaign": {
    },
  • "deletedAt": "2022-11-10T23:00:00Z"
}

Campaign priorities changed Webhook

Request Body schema: application/json

The notification indicating the priority of a campaign changed.

required
object

Application containing the campaigns whose priorities changed.

required
object

New campaign priorities

object

Previous campaign priorities

Array of objects

The previous positions of campaigns in the priority order.

Array of objects

The new positions of campaigns in the priority order.

Request samples

Content type
application/json
{
  • "application": {
    },
  • "oldPriorities": {
    },
  • "priorities": {
    },
  • "oldPrioritiesPositions": [
    ],
  • "prioritiesPositions": [
    ]
}