Create callback

Preliminary Remarks

What are callbacks?

Callbacks make it possible to transfer information on defined events in the Frisbii Media system to other systems in real time.

When integrating Frisbii Media, it may be desirable for third-party systems to receive information about events that occur in the Frisbii Media system so that these systems can perform actions accordingly. For this purpose, so-called callbacks can be defined for certain events in the Merchant Backend. They are created and managed at client level.

Note on data protection:

When using most callback types, personal data is transmitted. The receiving system can therefore be defined as an additional commissioned data processor from the perspective of the applicable jurisdiction. This should be taken into account when using callbacks.  

We have created a separate entry for examples of payloads: Payloads - Examples  

Create and activate callbacks

Create callback (without authentication)  

• In the action bar, click on +Create a Callback.

• Enter the URL of your own web service. 
  As soon as the URL has been entered, the Enabled checkbox can be clicked to activate the callback.

• Select Callback type using the drop-down menu (e. g. "Create customer").

• Save settings.

After saving, the Frisbii Media System automatically generates a separate callback secret for each callback, which can be viewed when opening the callback in detail view.

Create callback (with authentication)

Note: We generally recommend using the security mechanism through authentication. 

• In the action bar, click on +Create a Callback.

• Activate checkbox Endpoint requires authentication .

• Method 1: Authentication via username and password
  The transmission of data can be secured by using basic authentication via username and password. In most cases, the receiving system determines the data for authentication. When using the secured callback, the authentication data is included in every Frisbii Media request.

• Method 2: Authentication via HTTP header
  HTTP headers can also be used to authenticate against a service.
  To do this, enter one or more key-value pair(s).

After saving, the Frisbii Media System automatically generates a separate callback secret for each callback, which can be viewed when opening the callback in detail view.

Manage Callbacks

All callbacks created are listed in the overview page.

• More information on a specific callback can be opened by clicking on Details.

• Callbacks can be edited by clicking on Edit.
  This might be necessary to disable or enable the callback, or in case of failed attempts, to change the URL of the webservice, or to adjust the callback type.

• The callback log can be searched for the specific callback ID by clicking on Search in Log.
  It will navigate to the callback log and set the filter for this specific callback ID.

Example Header

In the following example, both method 1 and method 2 of the safety mechanism were used. The settings in the Merchant Backend are as follows:

The authentication is transferred in the header of the callback. The values in bold are the corresponding authentication data set in the Merchant Backend. In addition, each callback is signed with a "plenigo-signature". How the signature can be checked is explained in more detail in the following entry: plenigo signature