WordPress: Callbacks

Introduction

XTM Connect – WordPress 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 – WordPress, 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 – WordPress about the finished task in XTM Cloud. Then, XTM Connect – WordPress will take the generated target file for each individual job, download it and upload it to WordPress, for each individual language, as the WPML content.


How does it work?

You can only see the callbacks from WordPress in your XTM Cloud instance if you are able to use callbacks. That is the case when you, for example, have had callbacks set up by the XTM International Support team in your account configuration or just have a valid API license.

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.

The table that is displayed shows the status of each callback sent from XTM Cloud to a third-party application (in this case, XTM Connect – WordPress). This way, XTM Cloud administrators can notice communication errors between XTM Cloud and WordPress 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.

  • 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, the 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, the 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.