Adding a callback

Note

If the Version is in the draft state, you can add a callback.
If the Version is any other state, you cannot.
For more information about Version states, see the Version approval section.

To add a callback

  1. Open the Version.

  2. Select Callbacks from the left-hand menu.

    ../../_images/ss-callback-list.png

  3. Click addcallback.

    ../../_images/ss-callback-add.png
  4. Enter a name and (optionally) a description for the callback.
    These are only displayed in your callback list.

  5. Specify a unique callback code and copy the CTI for use in your callback handler implementation.

  6. [Optional] Modify the default Advanced properties.

    ../../_images/ss-callback-adv-props.png

    1. [Optional] Select the Customize request timeout checkbox and set the amount of time that Acronis Cyber Platform will wait for a response.

    2. [Optional] Turn on the Retry policies toggle switch and specify your preferred failed request retry settings.

      Note

      When only Retry interval is specified, fixed interval retries are performed.
      When Retry interval and Delta are specified, the wait time between the retries could be calculated by the following formula: Retry interval + (count - 1) * Delta.
      When Retry interval, Delta and Maximum interval are specified, an Exponential backoff algorithm is applied. Wait time between the retries can be calculated by the following formula: Retry interval + (2^count - 1) * random(Delta * 0.8, Delta * 1.2).
      If calculated value exceeds Maximum interval, the time to the next interval will be calculated as: Maximum interval + random(Delta * -0.2, Delta * 0.2). Random delay helps prevent a synchronized wave of retries from multiple clients, also known as the thundering herd problem.

    3. [Optional - and only available if you turn on Retry policies] Turn on the Fast first retry toggle switch.

    4. [Optional] Turn on the Retention policy toggle switch and specify how long successful messages and failed messages should be retained for.

    5. [Optional] Select the Customize maximum number of messages per tenant checkbox and set the maximum.

  7. [Optional] Add the callback request payload.

  8. [Optional] Add the callback response payload.

  9. Click Save changes.