Documentation

Did you find this helpful?

Webhooks

In complex systems you may want to provide additional event handling on your custom server. PlayFab offers Webhooks to achieve this. Whenever new event is emitted, it can be forwarded to your server by making POST request to your custom web endpoint and event data is passed as JSON body.

Access Webhooks

To access Webhooks, select "Analytics" (1) in the sidebar menu. Then select "Webhooks" tab (2).

Overview

  1. "New Webhook" button allows you to create and configure new webhook
  2. Webhook name label, click to configure webhook
  3. Status label, shows if webhook is currently enabled
  4. Failing Since label, shows when webhook endpoint stopped returning OK responses
  5. Having some webhooks selected, use "Delete" button to permanently remove those webhooks.

Configuring Webhook

  1. Select Webhook name to uniquely identify webhook
  2. Set up the Endpoint URI. This URI will be hit when event occures
  3. You may set Webhook to be enabled/disabled. This allows temporarily suspend webhook without completely removing it from the system.
  4. Set up the filters to only process events you need. You can filter by Event Name, Event Source and PlayerID. You can have several filters per group. Each filter has to be matched for event to fall into group
  5. You may define several filter group to include different filters. Event must fall into at least one group to be passed to the webhook



Did you find this helpful?