☁️Synchronous webhooks

Introduction

Synchronous webhooks can be used for extending Magami, meaning that Magami expects a response of a particular shape from these webhooks to be returned to continue processing in Magami.

Adding synchronous webhooks will affect response time. Make sure that your app server can keep up with the requests.

Permissions

No permission needed yet.

Webhook protocol

Synchronous webhooks support only HTTP(S).

Webhook payloads are sent in POST requests.

Headers

During HTTPS requests there are several headers included:

• Magami-Event - defines an event which is assigned to the webhook

• Magami-Signature - defines a signature to indicate that the request is verifiable

Webhook payload object common properties

Each webhook event payload also contains properties unique to the event. You can find the unique properties in the individual event type sections.

Payload signature

Magami calculates a payload signature under Magami-Signature which was set with HMAC SHA-256 header based on the API key as the secret key and the payload.

Available webhook events

Name	Description
override_prize_draw_rules	Override prize/reward draw rules