Signals in Superdesk

We use Flask signals to allow custom development on Superdesk.

Usage:

from superdesk import item_update


def my_item_update_handler(sender, item, **kwargs):
    print('item updated', item)


def init_app(app):

    item_update.connect(my_item_update_handler)

Core Signals

item_update[source]

Sent before new version is saved.

Parameters:

  • sender – ArchiveService

  • updates – changes to be saved

  • original – original item version

item_publish[source]

Sent before item is published.

Added in version 1.30.

Parameters:

  • sender – PublishService

  • item – item to publish

item_published[source]

Sent when item is published.

Parameters:

  • sender – PublishService

  • item – published item

  • after_scheduled – True if signal raised after publish scheduled, False otherwise

item_fetched[source]

Sent after item is fetched.

Added in version 1.29.

Parameters:

  • sender – FetchService

  • item – fetched item in production

  • ingest_item – item in ingest

item_move[source]

Sent before item is moved to different desk/stage.

Added in version 1.33.

Parameters:

  • sender – MoveService

  • item – item after moving

  • original – item before moving

item_moved[source]

Sent after item is moved to different desk/stage.

Added in version 1.29.

Parameters:

  • sender – MoveService

  • item – item after moving

  • original – item before moving

item_rewrite[source]

Sent before item update is created

Added in version 1.29.

Parameters:

  • sender – ArchiveRewriteService

  • item – new item update

  • original – original item

item_validate[source]

Validate item

You can add errors to response and that will prevent publishing and display those errors to users.

Added in version 1.30.1.

Parameters:

  • sender – ValidateService

  • item – item to validate

  • response – human readable list or errors

  • error_fields – system readable errors info

item_duplicate[source]

Sent before item is duplicated

Added in version 2.0.

Parameters:

  • sender – ArchiveService

  • item – duplicated item to be saved

  • original – original item

  • operation – operation

item_duplicated[source]

Sent after item is duplicated

Added in version 2.0.

Parameters:

  • sender – ArchiveService

  • item – duplicated item

  • original – original item

  • operation – operation

archived_item_removed[source]

Sent then item is removed from archived

..versionadded:: 1.34

Parameters:

  • sender – archived service

  • item – item being removed from archived