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.

KeyTypeDescription
actionstringMost webhook payloads contain an action property that contains the specific activity that triggered the event.
actorobjectThe 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:

HeaderDescription
X-Sirius-EventName of the event that triggered the delivery.
X-Sirius-Event-IDID of the event that triggered the delivery.
X-Sirius-Delivery-IDID of the delivery.
X-Sirius-Status-IDID of the status (only if the app has declared an action for this event).
X-Sirius-Signature-256Sirius 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

KeyTypeDescription
actionstringThe action that was performed. Can be one of created, prePublish, published or dispatched.
actorobjectThe user that triggered the event.
articleobjectThe article object.
asNewContentbooleanIndicates if the article has been published as a new content (only for prePublish and published action).
scheduledbooleanIndicates if the article was published following a schedule (only for prePublish and published action).
dispatcherstringKey of the dispatcher (only for dispatched action).

Event Example

{
"actor": null,
"action": "created",
"article": {
"id": "dGVzdDpBcnRpY2xlOjI3OTg",
"url": null,
"live": null,
"name": "My title",
"slug": "/path/to/fake-url.html",
"tags": [
{
"id": "dGVzdDpUYWc6MzkxNTk",
"key": "international",
"name": "International",
"__typename": "Rubric",
"internalId": 39159
},
{
"id": "dGVzdDpUYWc6MzkxNjA",
"key": "france",
"name": "France",
"__typename": "Rubric",
"internalId": 39160
}
],
"chapo": "My chapo",
"state": "draft",
"title": "My title",
"blocks": [],
"layout": {
"id": "dGVzdDpMYXlvdXQ6Mjc4Nw",
"key": "basic",
"name": "Basic",
"internalId": 2787
},
"nbChar": 0,
"mainTag": {
"id": "dGVzdDpUYWc6MzkxNTk",
"key": "international",
"name": "International",
"__typename": "Rubric",
"internalId": 39159
},
"teasers": [
{
"type": {
"key": "enContinu"
},
"chapo": null,
"title": "My short teaser title",
"featureImage": null
},
{
"type": {
"key": "une"
},
"chapo": "My chapo",
"title": "My homepage teaser title",
"featureImage": null
},
{
"type": {
"key": "rubrique"
},
"chapo": null,
"title": "My title",
"featureImage": {
"size": null,
"image": {
"id": "dGVzdDpJbWFnZTo2",
"url": "https://local-focus.sirius.press/e75eaf85304ec4c",
"credit": null,
"caption": null,
"internalId": 6
},
"caption": null,
"position": null,
"croppings": [],
"defaultCropping": null
}
}
],
"services": [
{
"id": "dGVzdDpTZWN0aW9uOjQ3",
"name": "Super service",
"internalId": 47
}
],
"narrowTag": {
"id": "dGVzdDpUYWc6MzkxNjA",
"key": "france",
"name": "France",
"__typename": "Rubric",
"internalId": 39160
},
"nbCharMax": 4907,
"published": false,
"sourcings": [
{
"source": {
"id": "dGVzdDpTb3VyY2U6MjE",
"key": "le-monde",
"name": "Le Monde",
"internalId": 21
},
"partners": [
{
"key": "ap",
"name": "AP"
}
]
}
],
"internalId": 2798,
"signatures": [
{
"id": "dGVzdDpBcnRpY2xlQXV0aG9yOjIy",
"author": {
"id": "dGVzdDpBdXRob3I6NA",
"name": "James",
"avatar": null,
"origin": "JO",
"initials": "J",
"internalId": 4
},
"origin": null,
"internalId": 22
},
{
"id": "dGVzdDpBcnRpY2xlQXV0aG9yOjIz",
"author": {
"id": "dGVzdDpBdXRob3I6NQ",
"name": "Fred",
"avatar": null,
"origin": "FO",
"initials": "F",
"internalId": 5
},
"origin": "Custom origin",
"internalId": 23
}
],
"freeAuthors": [],
"pricingTier": {
"id": "dGVzdDpQcmljaW5nVGllcjoy",
"key": "premium",
"name": "Premium",
"internalId": 2
},
"publishedAt": null,
"featureImage": {
"size": null,
"image": {
"id": "dGVzdDpJbWFnZTo2",
"url": "https://local-focus.sirius.press/e75eaf85304ec4c",
"credit": null,
"caption": null,
"internalId": 6
},
"caption": null,
"position": null,
"croppings": [],
"defaultCropping": null
},
"layoutFormat": "standard",
"previousUrls": [],
"editorialType": {
"id": "dGVzdDpFZGl0b3JpYWxUeXBlOjIxNjQ",
"key": "factual",
"name": "Factual",
"internalId": 2164
},
"editorialLevel": 2,
"readingDuration": "P0D",
"eligibleForAudio": false,
"firstPublishedAt": null,
"prePublishVersion": {
"id": "dGVzdDpBcnRpY2xlUmV2aXNpb246NDU",
"internalId": 45
},
"legacyCustomFields": {
"tweet": null,
"video": {
"id": "dGVzdDpWaWRlbzo1",
"url": "http://kegovgot.fm/ci.mp4",
"title": "Ij dubtuwaju puh foz vu ha akoebbo uckok fimejmob losigeh hamu fipero rejfulre teamevus bifegzut hovo lufu iregimzuc.",
"width": null,
"credit": "Cora Pena",
"height": null,
"duration": null,
"provider": "digiteka",
"internalId": 5,
"description": "Ekba ecoca larbi jek ebbob ugu roadeju ucigakfi ciniwke connah jad ca baj apra rudjolzij catfif tor.",
"providerVideoId": "1000022879947644"
},
"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

KeyTypeDescription
actionstringThe action that was performed. Can be one of published.
actorobjectThe user that triggered the event.
articleBranchobjectThe article branch object.

Event Example

{
"actor": null,
"action": "published",
"articleBranch": {
"chapo": "My chapo",
"title": "My title",
"blocks": [],
"article": {
"id": "dGVzdDpBcnRpY2xlOjI4NjQ",
"url": null,
"name": "My title",
"tags": [
{
"id": "dGVzdDpUYWc6MzkyMzY",
"key": "international",
"name": "International",
"internalId": 39236
},
{
"id": "dGVzdDpUYWc6MzkyMzc",
"key": "france",
"name": "France",
"internalId": 39237
}
],
"chapo": "My chapo",
"state": "draft",
"title": "My title",
"blocks": [],
"layout": {
"id": "dGVzdDpMYXlvdXQ6MjkzNw",
"key": "basic",
"name": "Basic",
"internalId": 2937
},
"nbChar": 0,
"mainTag": {
"id": "dGVzdDpUYWc6MzkyMzY",
"key": "international",
"name": "International",
"internalId": 39236
},
"services": [
{
"id": "dGVzdDpTZWN0aW9uOjc0",
"name": "Super service",
"internalId": 74
}
],
"narrowTag": {
"id": "dGVzdDpUYWc6MzkyMzc",
"key": "france",
"name": "France",
"internalId": 39237
},
"nbCharMax": 4287,
"published": false,
"sourcings": [
{
"source": {
"id": "dGVzdDpTb3VyY2U6NTM",
"key": "le-monde",
"name": "Le Monde",
"internalId": 53
},
"partners": [
{
"key": "ap",
"name": "AP"
}
]
}
],
"internalId": 2864,
"signatures": [
{
"id": "dGVzdDpBcnRpY2xlQXV0aG9yOjQ2",
"author": {
"id": "dGVzdDpBdXRob3I6NDM",
"name": "James",
"avatar": null,
"origin": "JO",
"initials": "J",
"internalId": 43
},
"origin": null,
"internalId": 46
},
{
"id": "dGVzdDpBcnRpY2xlQXV0aG9yOjQ3",
"author": {
"id": "dGVzdDpBdXRob3I6NDQ",
"name": "Fred",
"avatar": null,
"origin": "FO",
"initials": "F",
"internalId": 44
},
"origin": "Custom origin",
"internalId": 47
}
],
"pricingTier": {
"id": "dGVzdDpQcmljaW5nVGllcjoyOA",
"key": "premium",
"name": "Premium",
"internalId": 28
},
"publishedAt": null,
"featureImage": {
"image": {
"id": "dGVzdDpJbWFnZTo4NQ",
"url": "https://local-focus.sirius.press/339b115a063809c",
"internalId": 85
},
"croppings": []
},
"editorialType": {
"id": "dGVzdDpFZGl0b3JpYWxUeXBlOjIyMjg",
"key": "factual",
"name": "Factual",
"internalId": 2228
},
"editorialLevel": 2,
"firstPublishedAt": null
},
"periodical": {
"id": "dGVzdDpQZXJpb2RpY2FsOjI4NjU",
"name": "Quotidien",
"path": "Quotidien",
"internalId": 2865
},
"featureImage": {
"image": {
"id": "dGVzdDpJbWFnZTo4NQ",
"url": "https://local-focus.sirius.press/339b115a063809c",
"internalId": 85
},
"croppings": []
},
"periodicalRelease": null,
"periodicalSection": {
"id": "dGVzdDpQZXJpb2RpY2FsU2VjdGlvbjozMA",
"name": "Culture",
"path": "Culture",
"internalId": 30
},
"periodicalEditionDate": null,
"periodicalSectionLayout": {
"id": "dGVzdDpQZXJpb2RpY2FsU2VjdGlvbkxheW91dDoyOQ",
"name": "Cover",
"path": "Cover",
"internalId": 29
}
},
"parentEventId": 25
}

articleBroadcast

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

Event Payload

KeyTypeDescription
actionstringThe action that was performed. Can be one of prePublish, published.
actorobjectThe user that triggered the event.
articleBranchobjectThe article branch object.

Event Example

{
"actor": null,
"action": "published",
"articleBroadcast": {
"id": "dGVzdDpBbGVydDoxOQ==",
"article": {
"id": "dGVzdDpBcnRpY2xlOjYxNjc=",
"internalId": 6167
},
"internalId": 19
}
}

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

KeyTypeDescription
actionstringThe action that was performed. Can be one of completed .
actorobjectThe user that triggered the event.
audioobjectThe audio object.
articleVersionobjectThe 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

KeyTypeDescription
actionstringThe action that was performed. Can be one of created, updated.
actorobjectThe user that triggered the event.
articleTaskobjectThe 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
}
}

author

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

Event Payload

KeyTypeDescription
actionstringThe action that was performed. Can be one of created or updated.
actorobjectThe user that triggered the event.
authorobjectThe author object.

Event Example

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

block

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

Event Payload

KeyTypeDescription
actionstringThe action that was performed. Can only be published.
actorobjectThe user that triggered the event.
blogobjectThe blog object.

Event Example

{
"actor": null,
"block": {
"id": "dGVzdDpTdGFnaW5nQXJlYToxMTg4Ng",
"type": "list",
"items": [
{
"id": "dGVzdDpTdGFnaW5nQXJlYUNvbnRlbnQ6MjA",
"tag": {
"id": "dGVzdDpUYWc6MzkxODM",
"__typename": "Rubric",
"internalId": 39183
},
"__typename": "TagListItem",
"internalId": 20
},
{
"id": "dGVzdDpTdGFnaW5nQXJlYUNvbnRlbnQ6MjE",
"pinned": true,
"article": {
"id": "dGVzdDpBcnRpY2xlOjgwOQ",
"internalId": 809
},
"siblings": {
"nodes": []
},
"__typename": "ArticleListItem",
"internalId": 21
}
],
"listType": {
"id": "dGVzdDpTdGFnaW5nQXJlYVR5cGU6NQ",
"key": "zone",
"name": "Zone",
"internalId": 5
},
"container": {
"id": "dGVzdDpUYWc6MzkxODI",
"internalId": 39182
},
"internalId": 11886
},
"action": "published"
}

blog

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

Event Payload

KeyTypeDescription
actionstringThe action that was performed. Can be one of created or updated.
actorobjectThe user that triggered the event.
blogobjectThe blog object.

Event Example

{
"blog": {
"id": "dGVzdDpCbG9nOjEy",
"key": "my-blog",
"name": "This is a blog",
"parent": {
"id": "dGVzdDpUYWc6OTY5",
"key": "my-tag",
"name": "This is a tag",
"internalId": 969
},
"internalId": 12
},
"actor": null,
"action": "updated"
}

contribution

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

Event Payload

KeyTypeDescription
actionstringThe action that was performed. Can be one of created or updated.
actorobjectThe user that triggered the event.
contributionobjectThe contribution object.

Event Example

{
"actor": null,
"action": "created",
"contribution": {
"id": "dGVzdDpDb250cmlidXRpb246MTA=",
"date": "2049-03-21T16:14:24.191Z",
"text": "Lor ceuji sevu uvu jikiv fogufo lertorvi zetjasobu ti onvus enril datuf nomum pisduf om nidepdi osnup umogodpu.",
"authorName": "Clara Neal",
"internalId": 10,
"authorEmail": "ewnase@felafu.ca"
}
}

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

KeyTypeDescription
actionstringThe action that was performed. Can be one of created or updated.
actorobjectThe user that triggered the event.
[key]objectThe 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

KeyTypeDescription
actionstringThe action that was performed. Can be one of created or updated
actorobjectThe user that triggered the event.
editorialTypeobjectThe 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

KeyTypeDescription
actionstringThe action that was performed. Can be one of completed.
actorobjectThe user that triggered the event.
ftpImportItemobjectThe 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

KeyTypeDescription
actionstringThe action that was performed. Can be one of created, opened or closed.
actorobjectThe user that triggered the event.
liveobjectThe live object.

Event Example

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

newsletter

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

Event Payload

KeyTypeDescription
actionstringThe action that was performed. Can be one of sent.
actorobjectThe user that triggered the event.
newsletterobjectThe 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

KeyTypeDescription
actionstringThe action that was performed. Can be one of scheduled, unscheduled orpublished.
actorobjectThe user that triggered the event.
newsletterEditionobjectThe newsletterEdition object.

Event Example

{
"actor": null,
"action": "scheduled",
"newsletterEdition": {
"id": "dGVzdDpQdWJsaWNhdGlvbjo5",
"date": "2021-06-01",
"internalId": 9,
"newsletter": {
"id": "dGVzdDpOZXdzbGV0dGVyOjk=",
"name": "Super newsletter",
"internalId": 9
},
"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

KeyTypeDescription
actionstringThe action that was performed. Can be one of published.
actorobjectThe user that triggered the event.
periodicalEditionobjectThe periodicalEdition object.

Event Example

{
"actor": null,
"action": "published",
"periodicalEdition": {
"id": "dGVzdDpQdWJsaWNhdGlvbjozOQ",
"date": "2021-04-18",
"blocks": [
{
"id": "dGVzdDpTdGFnaW5nQXJlYToxMTkyNA",
"name": "Rock Reggae",
"items": [
{
"id": "dGVzdDpTdGFnaW5nQXJlYUNvbnRlbnQ6Njc",
"article": {
"id": "dGVzdDpBcnRpY2xlOjM4NQ",
"title": "Mon super article",
"internalId": 385
},
"__typename": "ArticleListItem"
}
],
"listType": {
"id": "dGVzdDpTdGFnaW5nQXJlYVR5cGU6NDE",
"key": "zone",
"name": "mo",
"internalId": 41
},
"__typename": "ListBlock",
"internalId": 11924
}
],
"internalId": 39,
"periodical": {
"id": "dGVzdDpQZXJpb2RpY2FsOjQ4NA",
"name": "Réveil Courrier",
"path": "reveil-courrier",
"internalId": 484
}
}
}

periodicalRelease

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

Event Payload

KeyTypeDescription
actionstringThe action that was performed. Can be one of created or updated.
actorobjectThe user that triggered the event.
periodicalReleaseobjectThe 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

KeyTypeDescription
actionstringThe action that was performed. Can be one of published.
actorobjectThe user that triggered the event.
postobjectThe post object.

Event Example

{
"post": {
"id": "dGVzdDpQb3N0OjI4",
"flag": {
"id": "dGVzdDpGbGFnOjEw",
"key": "h@CHpHO9",
"name": "kanvonaj",
"color": "#1a55da",
"internalId": 10
},
"live": {
"id": "dGVzdDpMaXZlOjQ2",
"internalId": 46
},
"title": "This is a post",
"blocks": [
{
"id": "dGVzdDpQb3N0Tm9kZTozMA",
"html": "Hello",
"type": "text",
"textType": "paragraph",
"internalId": 30
},
{
"id": "dGVzdDpQb3N0Tm9kZTozMQ",
"url": "https://newspaper.sirius.press/articles/20",
"type": "link",
"title": null,
"prefix": "En savoir plus",
"article": {
"id": "dGVzdDpBcnRpY2xlOjI0NDU",
"title": "Super article",
"internalId": 2445
},
"internalId": 31
},
{
"id": "dGVzdDpQb3N0Tm9kZTozMg",
"type": "contribution",
"internalId": 32,
"contribution": {
"id": "dGVzdDpDb250cmlidXRpb246MTI",
"date": "2120-04-08T13:15:57.994Z",
"text": "Gitow owpim uhohahev uk hur huhokwe soboh weulomo wotil cok nuki kajnah zuza madkozloz.",
"authorName": "Eula Porter",
"internalId": 12,
"authorEmail": "ohosiz@kibhuv.kw"
}
},
{
"id": "dGVzdDpQb3N0Tm9kZTozMw",
"url": "http://li.bt/gan",
"type": "link",
"internalId": 33
},
{
"id": "dGVzdDpQb3N0Tm9kZTozNA",
"url": "https://www.dailymotion.com/video/1000063435172876",
"type": "link",
"video": {
"id": "dGVzdDpWaWRlbzoxMjU",
"title": "Zipi foki vaogo dowo juhurlaw follu zagiken nunin ibu huute vibleuv raz kebpupsak.",
"width": 100,
"height": 100,
"duration": null,
"provider": "dailymotion",
"internalId": 125,
"description": "Uvewuvu ih jeljoremi jo muzokan wap oncorag vezavfu wiher puplud tu ofocipsa teg."
},
"internalId": 34
},
{
"id": "dGVzdDpQb3N0Tm9kZTozNQ",
"type": "snippet",
"snippet": {
"id": "dGVzdDpTbmlwcGV0OjQ1",
"html": "<html><h1>Some HTML Code ! </h1></html>",
"name": "hiccozut",
"internalId": 45
},
"internalId": 35
},
{
"id": "dGVzdDpQb3N0Tm9kZTozNg",
"type": "image",
"imageView": {
"image": {
"id": "dGVzdDpJbWFnZTo1MzI",
"url": "https://local-focus.sirius.press/626681ab0294425",
"credit": "Some credit",
"caption": "Some caption",
"internalId": 532
},
"caption": "Une description personnalisée",
"croppings": []
},
"internalId": 36
},
{
"id": "dGVzdDpQb3N0Tm9kZTozNw",
"type": "content",
"content": {
"id": "dGVzdDpDdXN0b21UeXBlQ29udGVudDoyMQ",
"label": "ma",
"__typename": "ContentLuerop",
"internalId": 21
},
"internalId": 37
}
],
"deleted": false,
"internalId": 28,
"signatures": [
{
"author": {
"id": "dGVzdDpBdXRob3I6MTg0",
"name": "Leo Herrera",
"avatar": null,
"initials": "Jon Phelps",
"internalId": 184
},
"origin": "bajfozho"
}
],
"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

KeyTypeDescription
actionstringThe action that was performed. Can be one of created or updated.
actorobjectThe user that triggered the event.
rubricobjectThe rubric object.

Event Example

{
"actor": null,
"action": "updated",
"rubric": {
"id": "dGVzdDpUYWc6Mzk2NTc",
"key": "my-tag",
"main": true,
"name": "This is a tag",
"custom": {
"awesomeImg": {
"id": "dGVzdDpJbWFnZTo5MA",
"url": "https://local-focus.sirius.press/15f83c5a0ecb8c0",
"internalId": 90
},
"highlights": [
{
"id": "dGVzdDpBcnRpY2xlOjUyNA",
"url": null,
"internalId": 524
},
{
"id": "dGVzdDpBcnRpY2xlOjUyNQ",
"url": null,
"internalId": 525
}
]
},
"parent": null,
"enabled": true,
"homepage": false,
"internalId": 39657,
"activeTemplate": {
"id": "dGVzdDpUYWdUZW1wbGF0ZTozODA",
"key": "default",
"internalId": 380
}
}
}

snippet

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

Event Payload

KeyTypeDescription
actionstringThe action that was performed. Can be one of created or updated.
actorobjectThe user that triggered the event.
snippetobjectThe snippet object.

Event Example

{
"actor": {
"id": "dGVzdDpVc2VyOjY4NQ==",
"email": "test@sirius.press"
},
"action": "updated",
"snippet": {
"id": "dGVzdDpTbmlwcGV0OjE3",
"html": "<h1>My beautiful snippet</h1>",
"name": "My beautiful snippet",
"internalId": 17
}
}

source

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

Event Payload

KeyTypeDescription
actionstringThe action that was performed. Can be one of created or updated.
actorobjectThe user that triggered the event.
sourceobjectThe 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
}
}
Edit this page on GitHub