Create callback

Prev Next

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 callback

Create callback (without authentication)  

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

Create callback (with authentication)

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

  • 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 more information about the callback is expanded.


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  

Headers

accept-encoding

gzip

x-plenigo-api version

20240827

plenigo-signature

t=1729583536,s=fdcd0a0ccd0b4db629d35a33c3aada5cf669a28f91adb38abcc9ffcdb1663d38

Test

Test2

content-type

application/json

authorization

Basic cGxlbmlnb190ZXN0OjEyMzQ1Njc4OQ==

accept

application/json

content-length

686

user-agent

go-resty/2.15.3 (https://github.com/go-resty/resty)

host

webhook.site

php-auth-user

Test

php-auth-pw

xxxxxxx