Events

All webhook events sent to your endpoint will contain an eventType and data properties.‍

The data property is specific to the event that triggered it and includes an array of affected copy components. This ensures that events happening in bulk will trigger your endpoints once for each action.

Components creation

Triggered each time components are created.

{
    eventType: "components.created",
    data: {
        components: [{
            _fttdInternalComponentId, // Frontitude's internal id, can be helpful for debugging.
            uniqueKey, // if a unique key isn't set, it will be auto-set with a temporary persistent unique id that starts with the 'frontitude-' prefix.
            name,
            value, // a string if the component is not pluralized, else, an object that represents plurals: { zero?, one?, two?, few?, many?, other? }.
            tags, // string array
            status, // "New"/"Draft"/"Review"/"Final"
            note,
            frontitudeLink
        }]
    }
}

Components deletion

Triggered each time components are deleted.

{
    eventType: "components.deleted",
    data: {
        components: [{
            _fttdInternalComponentId, // Frontitude's internal id, can be helpful for debugging.
            uniqueKey // if a unique key isn't set, it will be auto-set with a temporary persistent unique id that starts with the 'frontitude-' prefix.
        }]
    }
}‍

Components value change

Triggered each time components’ values are changed (including plurals) in any language (source language or translations).

{
    eventType: "components.value.changed",
    data: {
        components: [{
            _fttdInternalComponentId, // Frontitude's internal id, can be helpful for debugging.
            uniqueKey, // if a unique key isn't set, it will be auto-set with a temporary persistent unique id that starts with the 'frontitude-' prefix.
            localeId, // locale id is set for target translation languages, else, for source language it will be set as undefined.
            value, // a string if the component is not pluralized, else, an object that represents plurals: { zero?, one?, two?, few?, many?, other? }.
                   // if a translation was removed for the locale id, the value may be unset.
            previousValue // may be undefined if it's the first time this locale id was translated into
        }]
    }
}

‍

Components status change

Triggered each time components' statuses are changed in any language (source language or translations).

{
    eventType: "components.status.changed",
    data: {
        components: [{
            _fttdInternalComponentId, // Frontitude's internal id, can be helpful for debugging.
            uniqueKey, // if a unique key isn't set, it will be auto-set with a temporary persistent unique id that starts with the 'frontitude-' prefix.
            localeId, // locale id is set for target translation languages, else, for source language it will be set as undefined.
            status, // "New"/"Draft"/"Review"/"Final"
            previousStatus
        }]
    }
}

Components unique key change

Triggered each time components' unique keys are changed.

{
    eventType: "components.uniqueKey.changed",
    data: {
        components: [{
            _fttdInternalComponentId, // Frontitude's internal id, can be helpful for debugging.
            uniqueKey, // if a unique key isn't set, it will be auto-set with a temporary persistent unique id that starts with the 'frontitude-' prefix.
            previousUniqueKey
        }]
    }
}