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": "dGVzdDpBcnRpY2xlOjY5NzA","set": {"id": "dGVzdDpBcnRpY2xlU2V0OjMz","type": "hierarchy","title": null,"articles": [{ "id": "dGVzdDpBcnRpY2xlOjY5NzA", "internalId": 6970 },{ "id": "dGVzdDpBcnRpY2xlOjY5NzE", "internalId": 6971 },{ "id": "dGVzdDpBcnRpY2xlOjY5NzI", "internalId": 6972 }],"internalId": 33,"description": null},"url": null,"live": null,"name": "My title","slug": "/path/to/fake-url.html","tags": [{"id": "dGVzdDpUYWc6MTQ3NQ","key": "international","name": "International","__typename": "Rubric","internalId": 1475},{"id": "dGVzdDpUYWc6MTQ3Ng","key": "france","name": "France","__typename": "Rubric","internalId": 1476}],"chapo": "My chapo","state": "draft","title": "My title","blocks": [],"layout": {"id": "dGVzdDpMYXlvdXQ6MTA5MjM","key": "basic","name": "Basic","internalId": 10923},"nbChar": 0,"deleted": false,"mainTag": {"id": "dGVzdDpUYWc6MTQ3NQ","key": "international","name": "International","__typename": "Rubric","internalId": 1475},"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//usr/libexec/0/0/0/0/0/0/75/0/beside.exe","size": null,"image": {"id": "dGVzdDpJbWFnZTozMzAz","url": "https://local-focus.sirius.press/usr/libexec/beside.exe","credit": null,"caption": null,"agencies": [{ "name": "afp" }],"internalId": 3303,"agencyUniqueId": null},"caption": null,"position": null,"croppings": [],"defaultCropping": null}},{"type": { "key": "enContinu" },"chapo": null,"title": "My short teaser title","featureImage": null}],"services": [{"id": "dGVzdDpTZWN0aW9uOjE0Mjg","name": "Super service","internalId": 1428}],"narrowTag": {"id": "dGVzdDpUYWc6MTQ3Ng","key": "france","name": "France","__typename": "Rubric","internalId": 1476},"nbCharMax": 1486,"published": false,"sourcings": [{"source": {"id": "dGVzdDpTb3VyY2U6Nzg1","key": "le-monde","name": "Le Monde","internalId": 785},"partners": [{ "key": "ap", "name": "AP" }]}],"internalId": 6970,"signatures": [{"id": "dGVzdDpBcnRpY2xlQXV0aG9yOjMyMA","author": {"id": "dGVzdDpBdXRob3I6NTQ4","name": "James","avatar": null,"origin": "JO","initials": "J","internalId": 548},"origin": null,"internalId": 320},{"id": "dGVzdDpBcnRpY2xlQXV0aG9yOjMyMQ","author": {"id": "dGVzdDpBdXRob3I6NTQ5","name": "Fred","avatar": null,"origin": "FO","initials": "F","internalId": 549},"origin": "Custom origin","internalId": 321}],"freeAuthors": [],"pricingTier": {"id": "dGVzdDpQcmljaW5nVGllcjozNjc","key": "premium","name": "Premium","internalId": 367},"publishedAt": null,"featureImage": {"url": "https://local-focus.sirius.press//usr/libexec/0/0/0/0/0/0/75/0/beside.exe","size": null,"image": {"id": "dGVzdDpJbWFnZTozMzAz","url": "https://local-focus.sirius.press/usr/libexec/beside.exe","credit": null,"caption": null,"agencies": [{ "name": "afp" }],"internalId": 3303,"agencyUniqueId": null},"caption": null,"position": null,"croppings": [],"defaultCropping": null},"layoutFormat": "standard","previousUrls": [],"editorialType": {"id": "dGVzdDpFZGl0b3JpYWxUeXBlOjc3MTg","key": "factual","name": "Factual","internalId": 7718},"editorialLevel": 2,"featuredMedias": [{"id": "dGVzdDpBcnRpY2xlOjY5NzA","type": "image","imageView": {"url": "https://local-focus.sirius.press//usr/libexec/0/0/0/0/0/0/75/0/beside.exe","size": null,"image": {"id": "dGVzdDpJbWFnZTozMzAz","url": "https://local-focus.sirius.press/usr/libexec/beside.exe","credit": null,"caption": null,"agencies": [{ "name": "afp" }],"internalId": 3303,"agencyUniqueId": null},"caption": null,"position": null,"croppings": [],"defaultCropping": null},"internalId": 6970}],"editorialFormat": {"id": "dGVzdDpFZGl0b3JpYWxGb3JtYXQ6MTk0","key": "desk","name": "Desk","internalId": 194},"readingDuration": "P0D","eligibleForAudio": false,"firstPublishedAt": null,"prePublishVersion": {"id": "dGVzdDpBcnRpY2xlUmV2aXNpb246NDAz","internalId": 403},"legacyCustomFields": {"tweet": null,"video": {"id": "dGVzdDpWaWRlbzo4OTc","url": "https://www.youtube.com/watch?v=0641f344-14da-4981-9875-a55e35e09f11","title": "Velut cruentus pecus viridis vesco.","width": null,"credit": "Spencer - Watsica","height": null,"duration": null,"provider": "youtube","internalId": 897,"description": "Alveus caveo tolero cupio officiis aeger facere.","providerVideoId": "0641f344-14da-4981-9875-a55e35e09f11"},"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": "dGVzdDpBcnRpY2xlOjM1MDg","url": null,"name": "My title","tags": [{"id": "dGVzdDpUYWc6Nzg5","key": "international","name": "International","internalId": 789},{"id": "dGVzdDpUYWc6Nzkw","key": "france","name": "France","internalId": 790}],"chapo": "My chapo","state": "draft","title": "My title","blocks": [],"layout": {"id": "dGVzdDpMYXlvdXQ6NjAwOA","key": "basic","name": "Basic","internalId": 6008},"nbChar": 0,"mainTag": {"id": "dGVzdDpUYWc6Nzg5","key": "international","name": "International","internalId": 789},"services": [{"id": "dGVzdDpTZWN0aW9uOjEwODk","name": "Super service","internalId": 1089}],"narrowTag": {"id": "dGVzdDpUYWc6Nzkw","key": "france","name": "France","internalId": 790},"nbCharMax": 85,"published": false,"sourcings": [{"source": {"id": "dGVzdDpTb3VyY2U6NjA5","key": "le-monde","name": "Le Monde","internalId": 609},"partners": [{ "key": "ap", "name": "AP" }]}],"internalId": 3508,"signatures": [{"id": "dGVzdDpBcnRpY2xlQXV0aG9yOjE2Ng","author": {"id": "dGVzdDpBdXRob3I6MzAx","name": "James","avatar": null,"origin": "JO","initials": "J","internalId": 301},"origin": null,"internalId": 166},{"id": "dGVzdDpBcnRpY2xlQXV0aG9yOjE2Nw","author": {"id": "dGVzdDpBdXRob3I6MzAy","name": "Fred","avatar": null,"origin": "FO","initials": "F","internalId": 302},"origin": "Custom origin","internalId": 167}],"pricingTier": {"id": "dGVzdDpQcmljaW5nVGllcjoyOTc","key": "premium","name": "Premium","internalId": 297},"publishedAt": null,"featureImage": {"url": "https://local-focus.sirius.press//opt/share/0/0/0/0/0/0/75/0/closely_sup.tar","image": {"id": "dGVzdDpJbWFnZToxNjIw","url": "https://local-focus.sirius.press/opt/share/closely_sup.tar","internalId": 1620},"croppings": []},"editorialType": {"id": "dGVzdDpFZGl0b3JpYWxUeXBlOjM0ODE","key": "factual","name": "Factual","internalId": 3481},"editorialLevel": 2,"firstPublishedAt": null},"periodical": {"id": "dGVzdDpQZXJpb2RpY2FsOjQ0OTA","name": "Quotidien","path": "Quotidien","internalId": 4490},"featureImage": {"url": "https://local-focus.sirius.press//opt/share/0/0/0/0/0/0/75/0/closely_sup.tar","image": {"id": "dGVzdDpJbWFnZToxNjIw","url": "https://local-focus.sirius.press/opt/share/closely_sup.tar","internalId": 1620},"croppings": []},"periodicalRelease": null,"periodicalSection": {"id": "dGVzdDpQZXJpb2RpY2FsU2VjdGlvbjoxNTQ3","name": "Culture","path": "Culture","internalId": 1547},"periodicalEditionDate": null,"periodicalSectionLayout": {"id": "dGVzdDpQZXJpb2RpY2FsU2VjdGlvbkxheW91dDo2NzA","name": "Cover","path": "Cover","internalId": 670}},"parentEventId": 354}
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": 365,"articleBroadcast": {"id": "dGVzdDpBbGVydDo3","text": "Coruscus sustineo cervus velit vir nobis complectus adaugeo.","title": "Terror canonicus creta desparatus at.","custom": { "description": ["This an alert description"] },"article": { "id": "dGVzdDpBcnRpY2xlOjM1MTY", "internalId": 3516 },"internalId": 7}}
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": "dGVzdDpBcnRpY2xlU3BlZWNoOjE","audio": {"id": "dGVzdDpBdWRpbzox","url": "https://test.files.sirius.press/audio/articles/30/23/dGVzdDpBcnRpY2xlU3BlZWNoOjE-audio.mp3","name": "my mp3 file","duration": "PT2M17S","internalId": 1},"internalId": 1,"articleVersion": {"id": "dGVzdDpBcnRpY2xlUmV2aXNpb246MjA2","date": "2026-09-08T07:51:24.894Z","article": { "id": "dGVzdDpBcnRpY2xlOjM1MTQ", "internalId": 3514 },"internalId": 206}}}
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": "dGVzdDpBcnRpY2xlOjM1MDc","title": "Mon article","layout": {"id": "dGVzdDpMYXlvdXQ6NjAwNg","name": "aQehlAiL","internalId": 6006},"internalId": 3507,"editorialType": {"id": "dGVzdDpFZGl0b3JpYWxUeXBlOjM0ODA","name": "Inflammatio cumque","internalId": 3480},"workflowState": {"id": "dGVzdDpXb3JrZmxvd1N0YXRlOjMxNg","name": "cura","internalId": 316}},"creator": {"id": "dGVzdDpVc2VyOjU1ODU","email": "Garland_Ledner@gmail.com","internalId": 5585},"assignee": {"id": "dGVzdDpVc2VyOjU1ODY","email": "Jade_Goodwin63@yahoo.com","internalId": 5586},"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
| 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": "dGVzdDpBdXRob3I6MzAz","name": "James Bond","avatar": null,"origin": "Spy","enabled": true,"initials": "JB","verified": true,"internalId": 303}}
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": "dGVzdDpTdGFnaW5nQXJlYToxMDg","type": "list","items": [{"id": "dGVzdDpTdGFnaW5nQXJlYUNvbnRlbnQ6MTg1","tag": {"id": "dGVzdDpUYWc6Nzkz","__typename": "Rubric","internalId": 793},"__typename": "TagListItem","internalId": 185},{"id": "dGVzdDpTdGFnaW5nQXJlYUNvbnRlbnQ6MTg2","pinned": true,"article": { "id": "dGVzdDpBcnRpY2xlOjM1MTM", "internalId": 3513 },"siblings": { "nodes": [] },"__typename": "ArticleListItem","internalId": 186}],"listType": {"id": "dGVzdDpTdGFnaW5nQXJlYVR5cGU6NDI","key": "zone","name": "Zone","internalId": 42},"container": {"id": "dGVzdDpUYWc6Nzky","__typename": "Rubric","internalId": 792},"internalId": 108},"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": "dGVzdDpCbG9nOjM","key": "my-blog","name": "This is a blog","custom": {"imageId": {"id": "dGVzdDpJbWFnZToxNjIz","url": "https://local-focus.sirius.press/home/user/dir/unbearably.xsl","internalId": 1623},"description": ["This a blog description"]},"parent": {"id": "dGVzdDpUYWc6Nzk0","key": "my-tag","name": "This is a tag","internalId": 794},"internalId": 3},"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": "dGVzdDpMaXZlSW5wdXQ6Mg","live": { "id": "dGVzdDpMaXZlOjQ2Mw", "internalId": 463 },"__typename": "ContributionLiveInput","internalId": 2,"contribution": {"id": "dGVzdDpDb250cmlidXRpb246Mw","date": "2026-08-23T14:07:57.155Z","text": "Cur aperiam neque virgo aveho.","authorName": "Einar_Hyatt","internalId": 3,"authorEmail": "Mohammad_Schmeler62@hotmail.com"}}}
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": "dGVzdDpDdXN0b21UeXBlQ29udGVudDoyMzA","label": "contabesco","fields": { "url": null, "image": null, "commentaires": "A comment" },"enabled": true,"internalId": 230}}
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": "dGVzdDpFZGl0b3JpYWxUeXBlOjM0OTI","key": "vergo-termes-termes","name": "Teres caste","enabled": true,"internalId": 3492}}
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": "dGVzdDpVc2VyOjU2MTA", "email": "test@sirius.press" },"action": "completed","ftpImportItem": {"id": "dGVzdDpGdHBJbXBvcnRJdGVtOjE","news": {"id": "dGVzdDpOZXdzOjYy","date": "2026-09-07T13:46:18.496Z","html": "Modi voluptatem commodi. Taceo quam amor adulatio subnecto nulla suggero spiritus. Eveniet testimonium decor demitto depono conor tollo corporis victus.","title": "Agnitio cauda via coadunatio.","priority": "DEFAULT","provider": { "name": "afp" }},"__typename": "NewsFtpImportItem","internalId": 1}}
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": "dGVzdDpMaXZlOjQ2NA","closed": true,"locked": false,"internalId": 464},"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
| 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": "dGVzdDpOZXdzbGV0dGVyOjE3","name": "Super newsletter","internalId": 17}}
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 orpublished. |
actor | object | The user that triggered the event. |
newsletterEdition | object | The newsletterEdition object. |
Event Example
{"actor": null,"action": "scheduled","newsletterEdition": {"id": "dGVzdDpQdWJsaWNhdGlvbjoxNw","date": "2021-06-01","internalId": 17,"newsletter": {"id": "dGVzdDpOZXdzbGV0dGVyOjE2","name": "Super newsletter","internalId": 16},"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": "dGVzdDpQdWJsaWNhdGlvbjoxNg","date": "2021-04-18","blocks": [{"id": "dGVzdDpTdGFnaW5nQXJlYToxMDc","name": "Rock Reggae","items": [{"id": "dGVzdDpTdGFnaW5nQXJlYUNvbnRlbnQ6MTg0","article": {"id": "dGVzdDpBcnRpY2xlOjM1MTI","title": "Mon super article","custom": {"description": "This is an article periodicalEdition description"},"internalId": 3512},"__typename": "ArticleListItem"}],"listType": {"id": "dGVzdDpTdGFnaW5nQXJlYVR5cGU6NDE","key": "zone","name": "Cognomen adipisci","internalId": 41},"__typename": "ListBlock","internalId": 107}],"internalId": 16,"periodical": {"id": "dGVzdDpQZXJpb2RpY2FsOjQ0OTQ","name": "Réveil Courrier","path": "reveil-courrier","internalId": 4494},"scheduledAt": null}}
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": "dGVzdDpQZXJpb2RpY2FsUmVsZWFzZTo0NDE","name": "Bilan du Monde - 2020-01-20","path": "2020-01-20","custom": {"periodicalReleaseImage": {"id": "dGVzdDpJbWFnZToxNjIy","url": "https://local-focus.sirius.press/net/eek.m1v","internalId": 1622}},"enabled": true,"sections": [],"internalId": 441,"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": "dGVzdDpQb3N0OjE","flag": {"id": "dGVzdDpGbGFnOjE","key": "wGpQTjdE","name": "quidem","color": "#7dc9c8","internalId": 1},"live": { "id": "dGVzdDpMaXZlOjQ2MQ", "internalId": 461 },"title": "This is a post","blocks": [{"id": "dGVzdDpQb3N0Tm9kZTox","html": "Hello","type": "text","textType": "paragraph","internalId": 1},{"id": "dGVzdDpQb3N0Tm9kZToy","url": "https://newspaper.sirius.press/articles/20","type": "link","title": "Super article","prefix": "En savoir plus","article": {"id": "dGVzdDpBcnRpY2xlOjM1MDQ","title": "Super article","internalId": 3504},"internalId": 2},{"id": "dGVzdDpQb3N0Tm9kZToz","type": "contribution","internalId": 3,"contribution": {"id": "dGVzdDpDb250cmlidXRpb246Mg","date": "2026-03-02T10:18:15.789Z","text": "Abundans advoco vox.","authorName": "Julie_Luettgen84","internalId": 2,"authorEmail": "Samanta_Heidenreich37@gmail.com"}},{"id": "dGVzdDpQb3N0Tm9kZTo0","url": "https://murky-obligation.info","type": "link","internalId": 4},{"id": "dGVzdDpQb3N0Tm9kZTo1","url": "https://uneven-shore.biz/","type": "link","video": {"id": "dGVzdDpWaWRlbzo1NjY","title": "Paens eligendi suggero.","width": 100,"height": 100,"duration": null,"provider": "digiteka","internalId": 566,"description": "Sublime admoneo aedificium."},"internalId": 5},{"id": "dGVzdDpQb3N0Tm9kZTo2","type": "snippet","snippet": {"id": "dGVzdDpTbmlwcGV0OjM1MQ","html": "<html><h1>Some HTML Code ! </h1></html>","name": "adsuesco","internalId": 351},"internalId": 6},{"id": "dGVzdDpQb3N0Tm9kZTo3","type": "image","imageView": {"url": "https://local-focus.sirius.press//home/user/dir/0/0/800/600/0/0/75/0/phooey_cruelty_proofread.m1v","image": {"id": "dGVzdDpJbWFnZToxNjE5","url": "https://local-focus.sirius.press/home/user/dir/phooey_cruelty_proofread.m1v","credit": "Some credit","caption": "Some caption","internalId": 1619},"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": 7},{"id": "dGVzdDpQb3N0Tm9kZTo4","type": "content","content": {"id": "dGVzdDpDdXN0b21UeXBlQ29udGVudDoyMjk","label": "vobis","__typename": "ContentIn","internalId": 229},"internalId": 8}],"deleted": false,"internalId": 1,"signatures": [{"author": {"id": "dGVzdDpBdXRob3I6MzAw","name": "Garry Kreiger","avatar": null,"initials": "Lu. Mc.","internalId": 300},"origin": "St. George"}],"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": "dGVzdDpUYWc6Nzkx","key": "my-tag","main": true,"name": "This is a tag","custom": {"awesomeImg": {"id": "dGVzdDpJbWFnZToxNjIx","url": "https://local-focus.sirius.press/media/sneaky_who.deb","internalId": 1621},"highlights": [{ "id": "dGVzdDpBcnRpY2xlOjM1MTA", "url": null, "internalId": 3510 },{ "id": "dGVzdDpBcnRpY2xlOjM1MTE", "url": null, "internalId": 3511 }]},"parent": null,"enabled": true,"homepage": false,"__typename": "SeasonTag","internalId": 791,"activeTemplate": {"id": "dGVzdDpUYWdUZW1wbGF0ZToyMw","key": "default","internalId": 23}}}
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": "dGVzdDpVc2VyOjU2MDM", "email": "test@sirius.press" },"action": "updated","snippet": {"id": "dGVzdDpTbmlwcGV0OjM1Mg","html": "<h1>My beautiful snippet</h1>","name": "My beautiful snippet","internalId": 352,"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
Edit this page on GitHub{"actor": { "id": "dGVzdDpVc2VyOjU2MzA", "email": "test@sirius.press" },"action": "updated","source": {"id": "dGVzdDpTb3VyY2U6NjEw","key": "lemonde","name": "Le Monde","custom": {"sourceImage": {"id": "dGVzdDpJbWFnZToxNjI0","url": "https://local-focus.sirius.press/etc/namedb/whether_parsnip_meh.xhtml","internalId": 1624}},"partners": [{ "key": "afp", "name": "AFP" }],"internalId": 610}}