Webhooks
/
Webhook API

Webhook Api reference

Download OpenAPI description
webhooks.json
webhooks.yaml
Languages
Servers
Mock server
https://redocly.sportalliance.com/_mock/apis/magicline/webhooks/webhooks/

Webhook API

Example webhook endpoint

Operations

Event call

Request

Bodyapplication/jsonrequired
entityIdinteger(int64)required

Entity Id bounded to event

Example: 7893459
uuidstring(uuid)required

Unique Event UUID

payloadArray of objects(WebhookEvent)required

Currently single element

payload[].​timestampinteger(int64)required

Milliseconds since Unix Epoch

Example: 1642779144176
payload[].​typestringrequired
Example: "CUSTOMER_CREATED"
payload[].​contentobject

Additional data specific for event. Currently placeholder for future more complex events. More information in Event types section.

Example: {"field":"value"}
curl -i -X POST \
  https://redocly.sportalliance.com/_mock/apis/magicline/webhooks/webhooks/webhook \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "entityId": 7893459,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "payload": [
      {
        "timestamp": 1642779144176,
        "type": "CUSTOMER_CREATED",
        "content": {
          "field": "value"
        }
      }
    ]
  }'

Responses

OK