Events and payloads

For each webhook event, you can review when the event occurs, an example payload, and descriptions about the payload object parameters.

Common properties

Each webhook event payload also contains properties unique to the event. You can find the unique properties in the individual event type sections.

Key	Type	Description
`action`	`string`	Most webhook payloads contain an `action` property that contains the specific activity that triggered the event.
`actor`	`object`	The user that triggered the event.

Transports

HTTP Webhook

When using HTTP Webhook, events are sent using HTTP "POST" method to the specified URL with the payload of the event as the body of the request.

The request is encoded in JSON and specify a Content-Type: application/json;charset=utf-8 header.

We consider the webhook as timed out after 10s.

Once your server is configured to receive payloads, it'll listen for any payload sent to the endpoint you configured. For security reasons, you probably want to limit requests to those coming from Sirius. For this purpose, Sirius allows you to set up a secret token and validate the information.

Delivery headers

HTTP POST payloads that are delivered to your webhook's configured URL endpoint will contain several special headers:

Header	Description
`X-Sirius-Event`	Name of the event that triggered the delivery.
`X-Sirius-Event-ID`	ID of the event that triggered the delivery.
`X-Sirius-Delivery-ID`	ID of the delivery.
`X-Sirius-Status-ID`	ID of the status (only if the app has declared an action for this event).
`X-Sirius-Signature-256`	Sirius signature (only if the app has declared a secret).

Learn more about securing your webhooks.

Example

> POST /payload HTTP/1.1

> Host: localhost:4567
> X-Sirius-Event: live
> X-Sirius-Event-ID: ZGV2ZWxvcG1lbnQtbGVtb25kZTpFdmVudDozMDAy
> X-Sirius-Delivery-ID: ZGV2ZWxvcG1lbnQtbGVtb25kZTpBcHBEZWxpdmVyeToxMjM4MA==
> X-Sirius-Status-ID: ZGV2ZWxvcG1lbnQtbGVtb25kZTpTdGF0dXM6MjMwMQ==
> X-sirius-Signature-256: sha256=AfyckdFQ6tx5VgqCTJnMEueub9W0v/Koci+oyD89E+4=
> Content-Type: application/json
> Content-Length: 6615

> {
>   "action": "opened",
>   "live": {
>     "id": "...",
>     ...
>   },
>   "actor": {
>     "id": 1,
>     "email": "...",
>     ...
>   }
> }

GCP Pub/Sub

When using GCP Pub/Sub, event are sent in a topic with a JSON payload.

Delivery payload

type DeliveryMessage = {
  deliveryId: string;
  statusId: string;
  eventId: string;
  event: { name: string; payload: object };
};

Example

{
  "deliveryId": "ZGV2ZWxvcG1lbnQtbGVtb25kZTpBcHBEZWxpdmVyeToxMjM4MA==",
  "statusId": "ZGV2ZWxvcG1lbnQtbGVtb25kZTpTdGF0dXM6MjMwMQ==",
  "eventId": "ZGV2ZWxvcG1lbnQtbGVtb25kZTpFdmVudDozMDAy",
  "event": {
    "action": "opened",
    "live": {
      "id": "..."
      // ...
    },
    "actor": {
      "id": "ZGV2ZWxvcG1lbnQtbGVtb25kZTpVc2VyOjIz",
      "email": "..."
      // ...
    }
  }
}

Differences between GCP Pub/Sub ACK and statuses

Acking the message in GCP Pub/Sub does not notify Sirius and will not update any status in Sirius. To notify Sirius that your application has acknownledge the event, it has to update the status.

Events

article

Activity related to an Article. The type of activity is specified in the action property of the payload object.

Event Payload

Key	Type	Description
`action`	`string`	The action that was performed. Can be one of `created`, `prePublish`, `published` or `dispatched`.
`actor`	`object`	The user that triggered the event.
`article`	`object`	The article object.
`asNewContent`	`boolean`	Indicates if the article has been published as a new content (only for `prePublish` and `published` action).
`scheduled`	`boolean`	Indicates if the article was published following a schedule (only for `prePublish` and `published` action).
`dispatcher`	`string`	Key of the dispatcher (only for `dispatched` action).

Event Example

{
  "actor": null,
  "action": "created",
  "article": {
    "id": "dGVzdDpBcnRpY2xlOjE4MQ",
    "set": {
      "id": "dGVzdDpBcnRpY2xlU2V0OjQ",
      "type": "hierarchy",
      "title": null,
      "articles": [
        { "id": "dGVzdDpBcnRpY2xlOjE4MQ", "internalId": 181 },
        { "id": "dGVzdDpBcnRpY2xlOjE4Mg", "internalId": 182 },
        { "id": "dGVzdDpBcnRpY2xlOjE4Mw", "internalId": 183 }
      ],
      "internalId": 4,
      "description": null
    },
    "url": null,
    "live": null,
    "name": "My title",
    "slug": "/path/to/fake-url.html",
    "tags": [
      {
        "id": "dGVzdDpUYWc6Mzg",
        "key": "international",
        "name": "International",
        "__typename": "Rubric",
        "internalId": 38
      },
      {
        "id": "dGVzdDpUYWc6Mzk",
        "key": "france",
        "name": "France",
        "__typename": "Rubric",
        "internalId": 39
      }
    ],
    "chapo": "My chapo",
    "state": "draft",
    "title": "My title",
    "blocks": [],
    "layout": {
      "id": "dGVzdDpMYXlvdXQ6MTkx",
      "key": "basic",
      "name": "Basic",
      "internalId": 191
    },
    "nbChar": 0,
    "deleted": false,
    "mainTag": {
      "id": "dGVzdDpUYWc6Mzg",
      "key": "international",
      "name": "International",
      "__typename": "Rubric",
      "internalId": 38
    },
    "teasers": [
      {
        "type": { "key": "une" },
        "chapo": "My chapo",
        "title": "My homepage teaser title",
        "featureImage": null
      },
      {
        "type": { "key": "rubrique" },
        "chapo": null,
        "title": "My title",
        "featureImage": {
          "url": "https://local-focus.sirius.press//home/user/0/0/0/0/0/0/75/0/drat_shipper.ics",
          "size": null,
          "image": {
            "id": "dGVzdDpJbWFnZTozNg",
            "url": "https://local-focus.sirius.press/home/user/drat_shipper.ics",
            "credit": null,
            "caption": null,
            "agencies": [{ "name": "afp" }],
            "internalId": 36,
            "agencyUniqueId": null
          },
          "caption": null,
          "position": null,
          "croppings": [],
          "defaultCropping": null
        }
      },
      {
        "type": { "key": "enContinu" },
        "chapo": null,
        "title": "My short teaser title",
        "featureImage": null
      }
    ],
    "services": [
      { "id": "dGVzdDpTZWN0aW9uOjQ", "name": "Super service", "internalId": 4 }
    ],
    "narrowTag": {
      "id": "dGVzdDpUYWc6Mzk",
      "key": "france",
      "name": "France",
      "__typename": "Rubric",
      "internalId": 39
    },
    "nbCharMax": 953,
    "published": false,
    "sourcings": [
      {
        "source": {
          "id": "dGVzdDpTb3VyY2U6NQ",
          "key": "le-monde",
          "name": "Le Monde",
          "internalId": 5
        },
        "partners": [{ "key": "ap", "name": "AP" }]
      }
    ],
    "internalId": 181,
    "signatures": [
      {
        "id": "dGVzdDpBcnRpY2xlQXV0aG9yOjQ0",
        "author": {
          "id": "dGVzdDpBdXRob3I6NDQ",
          "name": "James",
          "avatar": null,
          "origin": "JO",
          "initials": "J",
          "internalId": 44
        },
        "origin": null,
        "internalId": 44
      },
      {
        "id": "dGVzdDpBcnRpY2xlQXV0aG9yOjQ1",
        "author": {
          "id": "dGVzdDpBdXRob3I6NDU",
          "name": "Fred",
          "avatar": null,
          "origin": "FO",
          "initials": "F",
          "internalId": 45
        },
        "origin": "Custom origin",
        "internalId": 45
      }
    ],
    "freeAuthors": [],
    "pricingTier": {
      "id": "dGVzdDpQcmljaW5nVGllcjo1",
      "key": "premium",
      "name": "Premium",
      "internalId": 5
    },
    "publishedAt": null,
    "featureImage": {
      "url": "https://local-focus.sirius.press//home/user/0/0/0/0/0/0/75/0/drat_shipper.ics",
      "size": null,
      "image": {
        "id": "dGVzdDpJbWFnZTozNg",
        "url": "https://local-focus.sirius.press/home/user/drat_shipper.ics",
        "credit": null,
        "caption": null,
        "agencies": [{ "name": "afp" }],
        "internalId": 36,
        "agencyUniqueId": null
      },
      "caption": null,
      "position": null,
      "croppings": [],
      "defaultCropping": null
    },
    "layoutFormat": "standard",
    "previousUrls": [],
    "editorialType": {
      "id": "dGVzdDpFZGl0b3JpYWxUeXBlOjE3OQ",
      "key": "factual",
      "name": "Factual",
      "internalId": 179
    },
    "editorialLevel": 2,
    "featuredMedias": [
      {
        "id": "dGVzdDpBcnRpY2xlOjE4MQ",
        "type": "image",
        "imageView": {
          "url": "https://local-focus.sirius.press//home/user/0/0/0/0/0/0/75/0/drat_shipper.ics",
          "size": null,
          "image": {
            "id": "dGVzdDpJbWFnZTozNg",
            "url": "https://local-focus.sirius.press/home/user/drat_shipper.ics",
            "credit": null,
            "caption": null,
            "agencies": [{ "name": "afp" }],
            "internalId": 36,
            "agencyUniqueId": null
          },
          "caption": null,
          "position": null,
          "croppings": [],
          "defaultCropping": null
        },
        "internalId": 181
      }
    ],
    "editorialFormat": {
      "id": "dGVzdDpFZGl0b3JpYWxGb3JtYXQ6NA",
      "key": "desk",
      "name": "Desk",
      "internalId": 4
    },
    "readingDuration": "P0D",
    "eligibleForAudio": false,
    "firstPublishedAt": null,
    "prePublishVersion": {
      "id": "dGVzdDpBcnRpY2xlUmV2aXNpb246MzA",
      "internalId": 30
    },
    "legacyCustomFields": {
      "tweet": null,
      "video": {
        "id": "dGVzdDpWaWRlbzo1",
        "url": "https://limited-loaf.info",
        "title": "Sordeo testimonium aut virtus.",
        "width": null,
        "credit": "Streich - Greenfelder",
        "height": null,
        "duration": null,
        "provider": "digiteka",
        "internalId": 5,
        "description": "Comptus crapula dolorum territo cogo.",
        "providerVideoId": "fe3a928b-00da-4488-875e-90047ded26bd"
      },
      "hidden": false,
      "snippet": null,
      "archives": null,
      "seoTitle": null,
      "portfolio": null,
      "coverMedia": null,
      "shortTitle": "My short teaser title",
      "rubricTitle": "My title",
      "allowComments": null,
      "homepageTitle": "My homepage teaser title",
      "scribbleLiveId": null,
      "seoDescription": null,
      "homepageSubhead": "My homepage teaser subhead",
      "forceShowInThread": false,
      "scribbleLiveTitle": null
    },
    "textToSpeechEnabled": true
  }
}

articleBranch

Activity related to an Article branch. The type of activity is specified in the action property of the payload object.

Event Payload

Key	Type	Description
`action`	`string`	The action that was performed. Can be one of `published`.
`actor`	`object`	The user that triggered the event.
`articleBranch`	`object`	The article branch object.

Event Example

{
  "actor": null,
  "action": "published",
  "articleBranch": {
    "chapo": "My chapo",
    "title": "My title",
    "blocks": [],
    "article": {
      "id": "dGVzdDpBcnRpY2xlOjgwNTk",
      "url": null,
      "name": "My title",
      "tags": [
        {
          "id": "dGVzdDpUYWc6NDA0MzM",
          "key": "international",
          "name": "International",
          "internalId": 40433
        },
        {
          "id": "dGVzdDpUYWc6NDA0MzQ",
          "key": "france",
          "name": "France",
          "internalId": 40434
        }
      ],
      "chapo": "My chapo",
      "state": "draft",
      "title": "My title",
      "blocks": [],
      "layout": {
        "id": "dGVzdDpMYXlvdXQ6OTg3OQ",
        "key": "basic",
        "name": "Basic",
        "internalId": 9879
      },
      "nbChar": 0,
      "mainTag": {
        "id": "dGVzdDpUYWc6NDA0MzM",
        "key": "international",
        "name": "International",
        "internalId": 40433
      },
      "services": [
        {
          "id": "dGVzdDpTZWN0aW9uOjc1Mg",
          "name": "Super service",
          "internalId": 752
        }
      ],
      "narrowTag": {
        "id": "dGVzdDpUYWc6NDA0MzQ",
        "key": "france",
        "name": "France",
        "internalId": 40434
      },
      "nbCharMax": 2093,
      "published": false,
      "sourcings": [
        {
          "source": {
            "id": "dGVzdDpTb3VyY2U6NDYz",
            "key": "le-monde",
            "name": "Le Monde",
            "internalId": 463
          },
          "partners": [{ "key": "ap", "name": "AP" }]
        }
      ],
      "internalId": 8059,
      "signatures": [
        {
          "id": "dGVzdDpBcnRpY2xlQXV0aG9yOjMzNQ",
          "author": {
            "id": "dGVzdDpBdXRob3I6NDU5",
            "name": "James",
            "avatar": null,
            "origin": "JO",
            "initials": "J",
            "internalId": 459
          },
          "origin": null,
          "internalId": 335
        },
        {
          "id": "dGVzdDpBcnRpY2xlQXV0aG9yOjMzNg",
          "author": {
            "id": "dGVzdDpBdXRob3I6NDYw",
            "name": "Fred",
            "avatar": null,
            "origin": "FO",
            "initials": "F",
            "internalId": 460
          },
          "origin": "Custom origin",
          "internalId": 336
        }
      ],
      "pricingTier": {
        "id": "dGVzdDpQcmljaW5nVGllcjo0MzE",
        "key": "premium",
        "name": "Premium",
        "internalId": 431
      },
      "publishedAt": null,
      "featureImage": {
        "url": "https://local-focus.sirius.press/f248d37055012ee/0/0/0/0/0/0/75/0/f248d37055012ee",
        "image": {
          "id": "dGVzdDpJbWFnZTo0MTcy",
          "url": "https://local-focus.sirius.press/f248d37055012ee",
          "internalId": 4172
        },
        "croppings": []
      },
      "editorialType": {
        "id": "dGVzdDpFZGl0b3JpYWxUeXBlOjgwMzE",
        "key": "factual",
        "name": "Factual",
        "internalId": 8031
      },
      "editorialLevel": 2,
      "firstPublishedAt": null
    },
    "periodical": {
      "id": "dGVzdDpQZXJpb2RpY2FsOjg1NDY",
      "name": "Quotidien",
      "path": "Quotidien",
      "internalId": 8546
    },
    "featureImage": {
      "url": "https://local-focus.sirius.press/f248d37055012ee/0/0/0/0/0/0/75/0/f248d37055012ee",
      "image": {
        "id": "dGVzdDpJbWFnZTo0MTcy",
        "url": "https://local-focus.sirius.press/f248d37055012ee",
        "internalId": 4172
      },
      "croppings": []
    },
    "periodicalRelease": null,
    "periodicalSection": {
      "id": "dGVzdDpQZXJpb2RpY2FsU2VjdGlvbjo5MzY",
      "name": "Culture",
      "path": "Culture",
      "internalId": 936
    },
    "periodicalEditionDate": null,
    "periodicalSectionLayout": {
      "id": "dGVzdDpQZXJpb2RpY2FsU2VjdGlvbkxheW91dDo1MDc",
      "name": "Cover",
      "path": "Cover",
      "internalId": 507
    }
  },
  "parentEventId": 1055
}

articleBroadcast

Activity related to an Article Broadcast. The type of activity is specified in the action property of the payload object.

Event Payload

Key	Type	Description
`action`	`string`	The action that was performed. Can be one of `prePublish`, `published`.
`actor`	`object`	The user that triggered the event.
`articleBranch`	`object`	The article branch object.

Event Example

{
  "actor": null,
  "action": "published",
  "parentEventId": 59,
  "articleBroadcast": {
    "id": "dGVzdDpBbGVydDoyMw",
    "text": "Genehras liog luudu kuhiwazo sebavuuke hevje atiiginot emton mog satfas hidodrik epfedvel gopiwvok cefeji feheb.",
    "title": "Zi tub sohka tu ontutru.",
    "article": { "id": "dGVzdDpBcnRpY2xlOjExNDE", "internalId": 1141 },
    "internalId": 23
  }
}

articleSpeech

Activity related to a generated text to speech. The type of activity is specified in the action property of the payload object.

Event Payload

Key	Type	Description
`action`	`string`	The action that was performed. Can be one of `completed` .
`actor`	`object`	The user that triggered the event.
`audio`	`object`	The audio object.
`articleVersion`	`object`	The articleVersion object.

Event Example

{
  "actor": null,
  "action": "completed",
  "articleSpeech": {
    "id": "dGVzdDpBcnRpY2xlU3BlZWNoOjM0",
    "audio": {
      "id": "dGVzdDpBdWRpbzozNQ",
      "url": "https://test.files.sirius.press/audio/articles/30/23/dGVzdDpBcnRpY2xlU3BlZWNoOjE-audio.mp3",
      "name": "my mp3 file",
      "duration": "PT2M17S",
      "internalId": 35
    },
    "internalId": 34,
    "articleVersion": {
      "id": "dGVzdDpBcnRpY2xlUmV2aXNpb246MTc0",
      "date": "2022-07-20T14:45:31.035Z",
      "article": { "id": "dGVzdDpBcnRpY2xlOjcyNw", "internalId": 727 },
      "internalId": 174
    }
  }
}

articleTask

Activity related to an Article task. The type of activity is specified in the action property of the payload object.

Event Payload

Key	Type	Description
`action`	`string`	The action that was performed. Can be one of `created`, `updated`.
`actor`	`object`	The user that triggered the event.
`articleTask`	`object`	The article task object.

Event Example

{
  "actor": null,
  "action": "created",
  "articleTask": {
    "id": "dGVzdDpNZXNzYWdlOjI",
    "status": "pending",
    "article": {
      "id": "dGVzdDpBcnRpY2xlOjI",
      "title": "Mon article",
      "layout": {
        "id": "dGVzdDpMYXlvdXQ6Mg",
        "name": "xrw6$4G]",
        "internalId": 2
      },
      "internalId": 2,
      "editorialType": {
        "id": "dGVzdDpFZGl0b3JpYWxUeXBlOjI",
        "name": "Lilly Cummings",
        "internalId": 2
      },
      "workflowState": {
        "id": "dGVzdDpXb3JrZmxvd1N0YXRlOjQ",
        "name": "viapus",
        "internalId": 4
      }
    },
    "creator": {
      "id": "dGVzdDpVc2VyOjc",
      "email": "uhi@gaka.rw",
      "internalId": 7
    },
    "assignee": {
      "id": "dGVzdDpVc2VyOjg",
      "email": "tafnih@sutaduk.no",
      "internalId": 8
    },
    "priority": "default",
    "__typename": "UserArticleTask",
    "internalId": 2
  }
}

campaign

Activity related to a campaign. The type of activity is specified in the action property of the payload object.

Event Payload

Key	Type	Description
`action`	`string`	The action that was performed. Can be `created` or `updated`.
`actor`	`object`	The user that triggered the event.
`campaign`	`object`	The campaign object.

Event Example

{
  "actor": null,
  "action": "created",
  "campaign": {
    "id": "...",
    "internalId": 0,
    "key": "rencontres-avec-la-redaction",
    "name": "Rencontres avec la rédaction",
    "partnerName": "Le Monde"
  }
}

author

Activity related to an Author. The type of activity is specified in the action property of the payload object.

Event Payload

Key	Type	Description
`action`	`string`	The action that was performed. Can be one of `created` or `updated`.
`actor`	`object`	The user that triggered the event.
`author`	`object`	The author object.

Event Example

{
  "actor": null,
  "action": "created",
  "author": {
    "id": "dGVzdDpBdXRob3I6MjE2",
    "name": "James Bond",
    "avatar": null,
    "origin": "Spy",
    "enabled": true,
    "initials": "JB",
    "verified": true,
    "internalId": 216
  }
}

block

Activity related to a Block. The type of activity is specified in the action property of the payload object.

Event Payload

Key	Type	Description
`action`	`string`	The action that was performed. Can only be `published`.
`actor`	`object`	The user that triggered the event.
`blog`	`object`	The blog object.

Event Example

{
  "actor": null,
  "block": {
    "id": "dGVzdDpTdGFnaW5nQXJlYToyMzg",
    "type": "list",
    "items": [
      {
        "id": "dGVzdDpTdGFnaW5nQXJlYUNvbnRlbnQ6MTk2",
        "tag": {
          "id": "dGVzdDpUYWc6MjI4",
          "__typename": "Rubric",
          "internalId": 228
        },
        "__typename": "TagListItem",
        "internalId": 196
      },
      {
        "id": "dGVzdDpTdGFnaW5nQXJlYUNvbnRlbnQ6MTk3",
        "pinned": true,
        "article": { "id": "dGVzdDpBcnRpY2xlOjExMzE", "internalId": 1131 },
        "siblings": { "nodes": [] },
        "__typename": "ArticleListItem",
        "internalId": 197
      }
    ],
    "listType": {
      "id": "dGVzdDpTdGFnaW5nQXJlYVR5cGU6MTI",
      "key": "zone",
      "name": "Zone",
      "internalId": 12
    },
    "container": {
      "id": "dGVzdDpUYWc6MjI3",
      "__typename": "Rubric",
      "internalId": 227
    },
    "internalId": 238
  },
  "action": "published"
}

blog

Activity related to a Blog. The type of activity is specified in the action property of the payload object.

Event Payload

Key	Type	Description
`action`	`string`	The action that was performed. Can be one of `created` or `updated`.
`actor`	`object`	The user that triggered the event.
`blog`	`object`	The blog object.

Event Example

{
  "blog": {
    "id": "dGVzdDpCbG9nOjU",
    "key": "my-blog",
    "name": "This is a blog",
    "custom": {
      "imageId": {
        "id": "dGVzdDpJbWFnZToyODQ",
        "url": "https://local-focus.sirius.press/6c2681013a39d69",
        "internalId": 284
      },
      "description": ["This a blog description"]
    },
    "parent": {
      "id": "dGVzdDpUYWc6MTMy",
      "key": "my-tag",
      "name": "This is a tag",
      "internalId": 132
    },
    "internalId": 5
  },
  "actor": null,
  "action": "updated"
}

contribution

Activity related to a LiveInput of type contribution. The type of activity is specified in the action property of the payload object.

Event Payload

Key	Type	Description
`action`	`string`	The action that was performed. Can be one of `created` or `updated`.
`actor`	`object`	The user that triggered the event.
`liveInput`	`object`	The liveInput object.

Event Example

{
  "actor": null,
  "action": "created",
  "liveInput": {
    "id": "dGVzdDpMaXZlSW5wdXQ6Nw",
    "live": { "id": "dGVzdDpMaXZlOjY", "internalId": 6 },
    "__typename": "ContributionLiveInput",
    "internalId": 7,
    "contribution": {
      "id": "dGVzdDpDb250cmlidXRpb246Ng",
      "date": "2092-06-04T08:44:14.984Z",
      "text": "Vuvuc vad neze piegepa hod uwce mo kikiw atoom harofem iclu lebvepi pun bati fo ulevulit fiwu cukile.",
      "authorName": "Ollie McGee",
      "internalId": 6,
      "authorEmail": "wululisu@esijusnag.th"
    }
  }
}

custom content type

Activity related to a Content type. The type of activity is specified in the action property of the payload object.

Event Payload

Key	Type	Description
`action`	`string`	The action that was performed. Can be one of `created` or `updated`.
`actor`	`object`	The user that triggered the event.
`[key]`	`object`	The content type object.

Event Example

{
  "actor": null,
  "action": "updated",
  "contentProductBrand": {
    "id": "dGVzdDpDdXN0b21UeXBlQ29udGVudDoxNzM",
    "label": "zu",
    "fields": { "url": null, "image": null, "commentaires": "A comment" },
    "enabled": true,
    "internalId": 173
  }
}

editorialType

Activity related to an Editorial Type. The type of activity is specified in the action property of the payload object.

Event Payload

Key	Type	Description
`action`	`string`	The action that was performed. Can be one of `created` or `updated`
`actor`	`object`	The user that triggered the event.
`editorialType`	`object`	The editorialType object.

Event Example

{
  "actor": null,
  "action": "updated",
  "editorialType": {
    "id": "dGVzdDpFZGl0b3JpYWxUeXBlOjg5MA",
    "key": "zilufozm",
    "name": "Verna Chambers",
    "enabled": true,
    "internalId": 890
  }
}

ftpImportItem

Activity related to a FtpImportItem. The type of activity is specified in the action property of the payload object.

Event Payload

Key	Type	Description
`action`	`string`	The action that was performed. Can be one of `completed`.
`actor`	`object`	The user that triggered the event.
`ftpImportItem`	`object`	The ftpImportItem object.

Event Example

{
  "actor": { "id": "dGVzdDpVc2VyOjM5NTM", "email": "test@sirius.press" },
  "action": "completed",
  "ftpImportItem": {
    "id": "dGVzdDpGdHBJbXBvcnRJdGVtOjIwOA",
    "news": {
      "id": "dGVzdDpOZXdzOjUx",
      "date": "2124-05-27T00:00:00.000Z",
      "html": "Tog fuhak ir cipufawuc gezuztar wusluhzo defi voavzup ekeoco di hulo woosawos ruze agha evpogves zo fobremfad. Enirooli vo gecteot nep jobzup rejaf pe pewtarum ace nis wusoj com. Zuap if iwi hokahug lup ajga hotfuncud omahsa zavefi lonwe jodji rim vucucaid najaham nim fi.",
      "title": "Sajim be vekelwo vogpe fecpoero inifife vidfodtuf uzse vuufvif vanome tij uc zogiuwa log henredud ze vipej erju.",
      "priority": "ALERT",
      "provider": { "name": "reuters" }
    },
    "__typename": "NewsFtpImportItem",
    "internalId": 208
  }
}

live

Activity related to a Live. The type of activity is specified in the action property of the payload object.

Event Payload

Key	Type	Description
`action`	`string`	The action that was performed. Can be one of `created`, `opened` or `closed`.
`actor`	`object`	The user that triggered the event.
`live`	`object`	The live object.

Event Example

{
  "live": {
    "id": "dGVzdDpMaXZlOjEzNA==",
    "closed": true,
    "locked": false,
    "internalId": 134
  },
  "actor": null,
  "action": "closed"
}

Activity related to a Newsletter. The type of activity is specified in the action property of the payload object.

Event Payload

Key	Type	Description
`action`	`string`	The action that was performed. Can be one of `sent`.
`actor`	`object`	The user that triggered the event.
`newsletter`	`object`	The newsletter object.

Event Example

{
  "actor": null,
  "action": "sent",
  "newsletter": {
    "id": "dGVzdDpOZXdzbGV0dGVyOjEw",
    "name": "Super newsletter",
    "internalId": 10
  }
}

newsletterEdition

Activity related to a Newsletter Edition. The type of activity is specified in the action property of the payload object.

Event Payload

Key	Type	Description
`action`	`string`	The action that was performed. Can be one of `scheduled`, `unscheduled` or`published`.
`actor`	`object`	The user that triggered the event.
`newsletterEdition`	`object`	The newsletterEdition object.

Event Example

{
  "actor": null,
  "action": "scheduled",
  "newsletterEdition": {
    "id": "dGVzdDpQdWJsaWNhdGlvbjozNQ",
    "date": "2021-06-01",
    "internalId": 35,
    "newsletter": {
      "id": "dGVzdDpOZXdzbGV0dGVyOjIz",
      "name": "Super newsletter",
      "internalId": 23
    },
    "scheduledAt": "2021-10-13T14:30:00.000Z"
  }
}

periodicalEdition

Activity related to a Periodical Edition. The type of activity is specified in the action property of the payload object.

Event Payload

Key	Type	Description
`action`	`string`	The action that was performed. Can be one of `published`.
`actor`	`object`	The user that triggered the event.
`periodicalEdition`	`object`	The periodicalEdition object.

Event Example

{
  "actor": null,
  "action": "published",
  "periodicalEdition": {
    "id": "dGVzdDpQdWJsaWNhdGlvbjoyNzY",
    "date": "2021-04-18",
    "blocks": [
      {
        "id": "dGVzdDpTdGFnaW5nQXJlYTozNTE",
        "name": "Rock Reggae",
        "items": [
          {
            "id": "dGVzdDpTdGFnaW5nQXJlYUNvbnRlbnQ6MjUw",
            "article": {
              "id": "dGVzdDpBcnRpY2xlOjk5NTM",
              "title": "Mon super article",
              "custom": {
                "description": "This is an article periodicalEdition description"
              },
              "internalId": 9953
            },
            "__typename": "ArticleListItem"
          }
        ],
        "listType": {
          "id": "dGVzdDpTdGFnaW5nQXJlYVR5cGU6NDE",
          "key": "zone",
          "name": "Deripio synagoga",
          "internalId": 41
        },
        "__typename": "ListBlock",
        "internalId": 351
      }
    ],
    "internalId": 276,
    "periodical": {
      "id": "dGVzdDpQZXJpb2RpY2FsOjEyNzAy",
      "name": "Réveil Courrier",
      "path": "reveil-courrier",
      "internalId": 12702
    }
  }
}

periodicalRelease

Activity related to a Periodical Release. The type of activity is specified in the action property of the payload object.

Event Payload

Key	Type	Description
`action`	`string`	The action that was performed. Can be one of `created` or `updated`.
`actor`	`object`	The user that triggered the event.
`periodicalRelease`	`object`	The periodicalRelease object.

Event Example

{
  "actor": null,
  "action": "updated",
  "periodicalRelease": {
    "id": "dGVzdDpQZXJpb2RpY2FsUmVsZWFzZTozMw==",
    "name": "Bilan du Monde - 2020-01-20",
    "path": "2020-01-20",
    "custom": {
      "periodicalReleaseImage": {
        "id": "dGVzdDpJbWFnZToyMg==",
        "url": "https://local-focus.sirius.press/e13865c346c59e9",
        "internalId": 22
      }
    },
    "enabled": true,
    "sections": [],
    "internalId": 33,
    "releaseDate": "2020-01-20"
  }
}

post

Activity related to a Post. The type of activity is specified in the action property of the payload object.

Event Payload

Key	Type	Description
`action`	`string`	The action that was performed. Can be one of `published`.
`actor`	`object`	The user that triggered the event.
`post`	`object`	The post object.

Event Example

{
  "post": {
    "id": "dGVzdDpQb3N0Ojg",
    "flag": {
      "id": "dGVzdDpGbGFnOjg",
      "key": "ZI9OXB]X",
      "name": "soweguka",
      "color": "#53f4ba",
      "internalId": 8
    },
    "live": { "id": "dGVzdDpMaXZlOjE5", "internalId": 19 },
    "title": "This is a post",
    "blocks": [
      {
        "id": "dGVzdDpQb3N0Tm9kZTo1Nw",
        "html": "Hello",
        "type": "text",
        "textType": "paragraph",
        "internalId": 57
      },
      {
        "id": "dGVzdDpQb3N0Tm9kZTo1OA",
        "url": "https://newspaper.sirius.press/articles/20",
        "type": "link",
        "title": "Super article",
        "prefix": "En savoir plus",
        "article": {
          "id": "dGVzdDpBcnRpY2xlOjU3",
          "title": "Super article",
          "internalId": 57
        },
        "internalId": 58
      },
      {
        "id": "dGVzdDpQb3N0Tm9kZTo1OQ",
        "type": "contribution",
        "internalId": 59,
        "contribution": {
          "id": "dGVzdDpDb250cmlidXRpb246OA",
          "date": "2105-05-01T02:34:02.414Z",
          "text": "Aha woptosnoz nikokev ud toal puberi cagkefid ode uwehuster havib obce zigiil niticwo madwore ruf paihlup ejidun.",
          "authorName": "Pauline Mann",
          "internalId": 8,
          "authorEmail": "cam@gi.mm"
        }
      },
      {
        "id": "dGVzdDpQb3N0Tm9kZTo2MA",
        "url": "http://nigmiha.td/hoij",
        "type": "link",
        "internalId": 60
      },
      {
        "id": "dGVzdDpQb3N0Tm9kZTo2MQ",
        "url": "https://www.youtube.com/watch?v=1000026162437793",
        "type": "link",
        "video": {
          "id": "dGVzdDpWaWRlbzoxOQ",
          "title": "Racfur fe gugitsa he fevla medazueca sovah hus as up rovpelam af zose ki zujob pobfep vupva wifpon.",
          "width": 100,
          "height": 100,
          "duration": null,
          "provider": "youtube",
          "internalId": 19,
          "description": "Suwapa wo wabme voheszim nuzifop ohjam bejis hadap hamin tepci utaseto gudni nunsoz."
        },
        "internalId": 61
      },
      {
        "id": "dGVzdDpQb3N0Tm9kZTo2Mg",
        "type": "snippet",
        "snippet": {
          "id": "dGVzdDpTbmlwcGV0Ojg",
          "html": "<html><h1>Some HTML Code ! </h1></html>",
          "name": "nunavsec",
          "internalId": 8
        },
        "internalId": 62
      },
      {
        "id": "dGVzdDpQb3N0Tm9kZTo2Mw",
        "type": "image",
        "imageView": {
          "image": {
            "id": "dGVzdDpJbWFnZToxOQ",
            "url": "https://local-focus.sirius.press/c099c193b9cb3ec",
            "credit": "Some credit",
            "caption": "Some caption",
            "internalId": 19
          },
          "caption": "Une description personnalisée",
          "croppings": [
            {
              "top": 0,
              "left": 0,
              "width": 800,
              "height": 600,
              "aspectRatio": { "key": "original" }
            },
            {
              "top": 200,
              "left": 0,
              "width": 800,
              "height": 200,
              "aspectRatio": { "key": "4:1" }
            },
            {
              "top": 100,
              "left": 0,
              "width": 800,
              "height": 400,
              "aspectRatio": { "key": "2:1" }
            }
          ],
          "defaultCropping": { "aspectRatio": { "key": "original" } }
        },
        "internalId": 63
      },
      {
        "id": "dGVzdDpQb3N0Tm9kZTo2NA",
        "type": "content",
        "content": {
          "id": "dGVzdDpDdXN0b21UeXBlQ29udGVudDo4",
          "label": "zujegi",
          "__typename": "ContentIfediwo",
          "internalId": 8
        },
        "internalId": 64
      }
    ],
    "deleted": false,
    "internalId": 8,
    "signatures": [
      {
        "author": {
          "id": "dGVzdDpBdXRob3I6MzA",
          "name": "Lora Moran",
          "avatar": null,
          "initials": "Charlotte Sandoval",
          "internalId": 30
        },
        "origin": "duedub"
      }
    ],
    "scheduledAt": null,
    "firstPublishedAt": "2021-01-01T00:00:00.000Z"
  },
  "actor": null,
  "action": "published"
}

rubric

Activity related to a Tag. The type of activity is specified in the action property of the payload object.

Event Payload

Key	Type	Description
`action`	`string`	The action that was performed. Can be one of `created` or `updated`.
`actor`	`object`	The user that triggered the event.
`rubric`	`object`	The rubric object.

Event Example

{
  "actor": null,
  "action": "updated",
  "rubric": {
    "id": "dGVzdDpUYWc6MTY3OA",
    "key": "my-tag",
    "main": true,
    "name": "This is a tag",
    "custom": {
      "awesomeImg": {
        "id": "dGVzdDpJbWFnZTo1MjA",
        "url": "https://local-focus.sirius.press/8966a01e9d4216f",
        "internalId": 520
      },
      "highlights": [
        { "id": "dGVzdDpBcnRpY2xlOjM2Ng", "url": null, "internalId": 366 },
        { "id": "dGVzdDpBcnRpY2xlOjM2Nw", "url": null, "internalId": 367 }
      ]
    },
    "parent": null,
    "enabled": true,
    "homepage": false,
    "__typename": "SeasonTag",
    "internalId": 1678,
    "activeTemplate": {
      "id": "dGVzdDpUYWdUZW1wbGF0ZToyNDA",
      "key": "default",
      "internalId": 240
    }
  }
}

snippet

Activity related to a Snippet. The type of activity is specified in the action property of the payload object.

Event Payload

Key	Type	Description
`action`	`string`	The action that was performed. Can be one of `created` or `updated`.
`actor`	`object`	The user that triggered the event.
`snippet`	`object`	The snippet object.

Event Example

{
  "actor": { "id": "dGVzdDpVc2VyOjM3OA", "email": "test@sirius.press" },
  "action": "updated",
  "snippet": {
    "id": "dGVzdDpTbmlwcGV0OjM1",
    "html": "<h1>My beautiful snippet</h1>",
    "name": "My beautiful snippet",
    "internalId": 35,
    "thirdPartyProvider": "Le Monde"
  }
}

source

Activity related to a Source. The type of activity is specified in the action property of the payload object.

Event Payload

Key	Type	Description
`action`	`string`	The action that was performed. Can be one of `created` or `updated`.
`actor`	`object`	The user that triggered the event.
`source`	`object`	The source object.

Event Example

{
  "actor": { "id": "dGVzdDpVc2VyOjY3Ng==", "email": "test@sirius.press" },
  "action": "updated",
  "source": {
    "id": "dGVzdDpTb3VyY2U6MTM1",
    "key": "lemonde",
    "name": "Le Monde",
    "custom": {
      "sourceImage": {
        "id": "dGVzdDpJbWFnZTozMjI=",
        "url": "https://local-focus.sirius.press/98978525d6aae14",
        "internalId": 322
      }
    },
    "partners": [{ "key": "afp", "name": "AFP" }],
    "internalId": 135
  }
}

Common properties​

Transports​

HTTP Webhook​

Delivery headers​

Example​

GCP Pub/Sub​

Delivery payload​

Example​

Differences between GCP Pub/Sub ACK and statuses​

Events​

article​

Event Payload​

Event Example​

articleBranch​

Event Payload​

Event Example​

articleBroadcast​

Event Payload​

Event Example​

articleSpeech​

Event Payload​

Event Example​

articleTask​

Event Payload​

Event Example​

campaign​

Event Payload​

Event Example​

author​

Event Payload​

Event Example​

block​

Event Payload​

Event Example​

blog​

Event Payload​

Event Example​

contribution​

Event Payload​

Event Example​

custom content type​

Event Payload​

Event Example​

editorialType​

Event Payload​

Event Example​

ftpImportItem​

Event Payload​

Event Example​

live​

Event Payload​

Event Example​

newsletter​

Event Payload​

Event Example​

newsletterEdition​

Event Payload​

Event Example​

periodicalEdition​

Event Payload​

Event Example​

periodicalRelease​

Event Payload​

Event Example​

post​

Event Payload​

Event Example​

rubric​

Event Payload​

Event Example​

snippet​

Event Payload​

Event Example​

source​

Event Payload​

Event Example​

Common properties

Transports

HTTP Webhook

Delivery headers

Example

GCP Pub/Sub

Delivery payload

Example

Differences between GCP Pub/Sub ACK and statuses

Events

article

Event Payload

Event Example

articleBranch

Event Payload

Event Example

articleBroadcast

Event Payload

Event Example

articleSpeech

Event Payload

Event Example

articleTask

Event Payload

Event Example

campaign

Event Payload

Event Example

author

Event Payload

Event Example

block

Event Payload

Event Example

blog

Event Payload

Event Example

contribution

Event Payload

Event Example

custom content type

Event Payload

Event Example

editorialType

Event Payload

Event Example

ftpImportItem

Event Payload

Event Example

live

Event Payload

Event Example

newsletter

Event Payload

Event Example

newsletterEdition

Event Payload

Event Example

periodicalEdition

Event Payload

Event Example

periodicalRelease

Event Payload

Event Example

post

Event Payload

Event Example

rubric

Event Payload

Event Example

snippet

Event Payload

Event Example

source

Event Payload

Event Example