Optimizely: Callbacks

Owned by Damian Rozmiarkowski (Unlicensed)
Last updated: Jul 18, 2024 by Damian Rozmiarkowski
3 min read

Introduction

XTM Connect – Optimizely is based on callbacks. A callback is information feedback from, for example, a system, after a particular task finishes. As soon as you send a request by means of XTM Connect – Optimizely, it creates a project and sends the source file to XTM Cloud via the API. After a particular job/project finishes, XTM Cloud sends a callback to XTM Connect – Optimizely about the finished task in XTM Cloud. Then, XTM Connect – Optimizely will take the generated target file for each individual job, download it, and upload it to Optimizely, for each individual language.

How does it work?

Enabling

You can only see the callbacks from Optimizely in your XTM Cloud instance if you are able to use callbacks.

  1. To enable callbacks, in the Optimizely CMS, go to XTM Connect → Settings → XTM Admin Tool → Settings, and select the Enable automatic import checkbox. You then see another option: Import content automatically. Here, select one of the two options: Once the single job is finished or Once the whole project is finished.

  1. The next step is to contact the XTM International Support team, by submitting a relevant issue request. They need to set up callback authentication in the database for your XTM Cloud instance.

Display

As mentioned, the Callbacks tab is present in your XTM Cloud instance. Log in to your environment and navigate to Configuration → Callbacks.

IMPORTANT!

You need to have an Administrator role to see the Callbacks tab.

You see a table that shows the status of each callback sent from XTM Cloud to a third-party application (in this case, XTM Connect – Optimizely). This enables XTM Cloud administrators to identify communication errors between XTM Cloud and Optimizely and react accordingly.

The table displays the following information:

  • Project ID: XTM ID of a particular project.

  • URL: The URL to which the callback has been sent.

  • Type: Possible default callback types for WordPress are:

    • Project finished.

    • Job finished.

    • Analysis finished.

  • Last attempt date: Click the blue arrow icon to sort in ascending order or descending order.

  • Status: Potential callback response statuses are in the following status groups:

    • Informational responses → codes 100–199.

    • Successful responses → codes 200–299.

    • Redirection messages → codes 300–399.

    • Client error responses → codes 400–499.

    • Server error responses → codes 500–599.

  • Status icon: If the callback has not been able to reach its endpoint, one of the following icons will be displayed and a tooltip will provide you with information about the callback:

    • Orange warning icon: If the callback has not reached its endpoint, but can still be resent automatically, a warning tooltip will be displayed, informing you about the number of automatic resend attempts remaining.

    • Red error icon: If the callback has not reached its endpoint and cannot be resent automatically, because the maximum number of resend attempts has been reached, an error tooltip will be displayed, informing you that the maximum number of attempts has been reached.

Only callbacks sent in the last 14 days are stored in XTM Cloud and can be displayed in the table.

By default, if a callback does not reach its endpoint, it will be resent three times with a 5000 millisecond timeout for responses and a 60000 millisecond timeout between each failed attempt. To customize the timeout, the number of resend attempts, or the intervals between consecutive resend attempts, contact the XTM International Support team and provide the details for your request.