<div class="panel-heading">
<div class="heading-elements">
<p>A <strong>webhook endpoint</strong> is used to capture events triggered by a segment publisher. You can configure the HTTP method (e.g., <code data-start="205" data-end="211">POST</code> or <code data-start="215" data-end="220">GET</code>) and define any necessary headers for authentication or other custom purposes. By default, the request content type is set to <code data-start="347" data-end="365">application/json</code>.</p>
</div>
</div>
<p>&nbsp;</p>
<blockquote>
<p><span style="color: rgb(230, 126, 35);">⚠️ The Webhook must be set to <strong>Published</strong> before being used.</span></p>
</blockquote>
<p>&nbsp;</p>
<p><img height="435" width="429" src="https://cdn.livechat-files.com/api/file/kb/file/96aa8fdc-d753-4dd9-8ac4-2e8059138a32/18bd052ba0-a3b48106107a6d42fbce.png" style="display: block; margin-left: auto; margin-right: auto;"></p>
<p>&nbsp;</p>
<hr>
<h2>Sample publisher event</h2>
<div>
<div><code>{</code><br><code>&nbsp; "Brand": "xxx.com",</code><br><code>&nbsp; "SegmentUid": "a1a00c0b-xxxx-xxxx-xxxx-09da0f9b59b2",</code><br><code>&nbsp; "SegmentName": "Sample segment",</code><br><code>&nbsp; "Timestamp": "2022-05-08T14:58:42.7979802Z",</code><br><code>&nbsp; "EnterPlayers": [</code><br><code>&nbsp; &nbsp; "Customer1A",</code><br><code>&nbsp; &nbsp; "Customer2B",</code><br><code>&nbsp; &nbsp; "1029128301"</code><br><code>&nbsp; ],</code><br><code>&nbsp; "EnterCount": 3,</code><br><code>&nbsp; "ExitPlayers": [</code><br><code>&nbsp; &nbsp; "01920n1b12"</code><br><code>&nbsp; ],</code><br><code>&nbsp; "ExitCount": 1</code><br><code>}</code></div>
</div>
<p>Where <strong>EnterCount</strong> defines the total number of players that have entered the segment since the last published event. <strong>ExitCount</strong> defines the total number of players that have exited the segment since the last published event.</p>
<p>&nbsp;</p>
<blockquote>
<p><span style="color: rgb(35, 111, 161);">ℹ️ For added security utilise IP whitelisting. Contact the <span style="text-decoration: underline;">product team</span> to request a list of IP addresses used in segment publishing.</span></p>
</blockquote>

A webhook endpoint is used to capture events triggered by a segment publisher. You can configure the HTTP method (e.g., POST or GET) and define any necessary headers for authentication or other custom purposes. By default, the request content type is set to application/json.

 

> ⚠️ The Webhook must be set to Published before being used.

 



 

----------------------------------------


SAMPLE PUBLISHER EVENT

{
  "Brand": "xxx.com",
  "SegmentUid": "a1a00c0b-xxxx-xxxx-xxxx-09da0f9b59b2",
  "SegmentName": "Sample segment",
  "Timestamp": "2022-05-08T14:58:42.7979802Z",
  "EnterPlayers": [
    "Customer1A",
    "Customer2B",
    "1029128301"
  ],
  "EnterCount": 3,
  "ExitPlayers": [
    "01920n1b12"
  ],
  "ExitCount": 1
}

Where EnterCount defines the total number of players that have entered the segment since the last published event. ExitCount defines the total number of players that have exited the segment since the last published event.

 

> ℹ️ For added security utilise IP whitelisting. Contact the product team to request a list of IP addresses used in segment publishing.

Creating a Webhook

Sample publisher event