Screen9 Callbacks

    Follow

    Not all uploads and changes are handled via your CMS. For example media is uploaded via Screen9 FTP or Screen9 Console, and media metadata is edited in Screen9 Console. In order to keep your CMS in sync with those changes, we support callbacks. To configure callback URL, please contact Screen9 Support.

    A callback is a HTTP GET request to a URL that you provide. Query parameters are appended to the URL depending on the flavor of the callback. Your callback handler is expected to respond with 200 on success. When success has not been achieved, Screen9 will retry the callback periodically for a maximum of 48 hours.

    There are two flavours of callbacks [1], along with what events that trigger the callback:

    Upload callback

    • A newly uploaded media has been set to successful, after all preview formats have been transcoded
    • Transcoding has been completely done
    • A clone has been created
    • A live event has been registered

    Appended to the URL as a query parameter is mediaid, status, title, userid and message (deprecated and always empty)

     http://cms.example.com?status=success&userid=rzLmShSpK-7kWkqh2oVCLA&message=&mediaid=hAHlHXzOLgOQI2La-hWFpg&title=Video+title 

    Update callback

    • A newly uploaded media has been set to successful, after all preview formats have been transcoded
    • A clone has been created
    • A live event has been registered
    • Media meta data has been edited in Screen9 Console. See below for a list of tracked meta data.

    Appended to the URL as a query parameter is the mediaid.

     http://cms.example.com?status=deleted&mediaid=-YBpbhPLZ7vQJnvYVBk-wh 

    Meta data that triggers a callback when edited via Screen9 Console:

    • category
    • description
    • moderation status
    • publication windows
    • live event start and end times
    • tags
    • title image and thumbnail
    • title

     

    [1] Additionally there is also a special purpose legacy callback still used by a selected few accounts.
     

    Was this article helpful?
    0 out of 0 found this helpful

    Comments