In-Game Popup Webhook

Through Aghanim's LiveOps Builder, developers can trigger in-game popups in response to player actions or interactions within the Aghanim-generated game hub. Once the conditions outlined in a campaign are met, Aghanim dispatches a webhook to your game containing the popup content specified in the campaign.

Upon receiving this webhook, your game is expected to display the in-game popup to players. The design and development of the frontend part of the popup should align with your game's visual and interaction guidelines.

Requirements

To use in-game popup webhooks from Aghanim, you should have the webhook server configured as follows:

• HTTPS endpoint, accepting POST webhook requests.
• Listen for events, generated and signed by Aghanim.
• Trigger the display of in-game popups using the received content, adhering to the game's design standards.
• Respond with 2xx status codes upon successful receipt and processing of the webhook, and 4xx or 5xx for denial or errors.

Configuration

1. Develop a function for the ingame.popup webhook processing.
2. Make your endpoint available.
3. Register your endpoint within Aghanim account → Game → Webhooks → New Webhook by choosing the in-game popup event type.
4. Configure a liveops campaign that will trigger an in-game popup webhook.

Guide on configuring a campaign for an in-game popup

Alternatively, you can register your endpoint within Aghanim using the Create Webhook API method.

The Event Data schema

Key	Type	Description
player_id	string	The unique Player ID chosen for player authentication to display the popup to.
title	string	The popup title.
body	string	The popup body.
icon	string|null	The popup icon URL.
url	string|null	URL to open in the browser when a player clicks on the popup.

Need help?
Contact our integration team at integration@aghanim.com