onRelease

The onRelease event type covers when any of the following events takes place:

  1. A release has been transferred to your organization.

  2. A release that has been transferred to your organization and is:

    1. updated;

    2. blocked;

    3. unblocked;

    4. deleted;

    5. revoked.

Please note that for transfers and revokes of releases that are executed by your own organization (through the API or web app), a notification is also sent to the callback endpoint.

This way you can update your internal systems when releases are transferred or revoked manually, in the SCR web application.

Payload

When the onRelease event occurs, the callback is invoked with the following data:

Value
Description

release

The address of the release.

event

A string denoting the event, being one of the following:

transfer, update, block, unblock, delete, revoke*, greenlights.

organization

The address for which the event is reported.

vat

The VAT no of the organization for which the event is reported.

The last two fields are added for organizations with multiple legal entities. This way, you can collect the notifications using one endpoint and route them to the correct (internal) system using these fields.

* For revoke action, the following parties are notified:

  • If the API is version 1.2.3 or lower only the current and the new owner receive a notification in the API.

  • If the API is version 1.2.4 or higher all organizations that are in the ownership chain of the release receive a notification in the API.

EXAMPLES

Please see below examples of onRelease events:

{
    "release": "0x000000000000000000000000000000000000000",
    "event": "TRANSFER",
    "organization": "0x000000000000000000000000000000000000000",
    "vat": "BETEST"
}

After you have received the event you would want to retrieve the latest data.

Last updated