Webhook Subscriptions

You can manage all your webhook subscriptions through the Lucra Webhook Subscriptions API. The full URL along with required API key will be provided by our Lucra account manager.

Some considerations:

• You have max limit of 5 webhook config records

• Each config can have all the subscriptions, or only the subscriptions you choose (except for the single instance subscriptions)

• Single Instance Subscriptions can only exist in 1 config record at a time, for example C2CWithdrawal

Create a New Subscription

POST /api/rest/webhook/configs

{
  "apiKey": "your-Lucra-assigned-api-key", // contact account manager for details
  "object" {
    "subscriptions": ["FtpMatchupCreated"],  // webhook event name(s) (array of strings)
    "webhookUrl": "https://test.com/lucra-game-matchups", // full URL to deliver webhook events to (string)
    "name": "Free to Play Game Matchups Created", // optional name for your reference (string)
    "description": "Sync Game Matchups", // optional description for your reference (string)
    "active": "true", // whether events should be delivered or not (boolean)
    "headers": JSON.stringify({'x-sample-header': sample-value}), // optional headers (or empty string) to be included when Lucra delivers webhook payloads (string)
    "expirationDate": "2030-12-31T00:00:00+00:00" // optional timestamp to expire the subscription(s)
  }
}

Available Subscriptions

• FundsDeposited

• C2CWithdrawal

• UserSignedUp

• UserKYCVerified

• TournamentCreated

• TournamentCanceled

• TournamentCompleted

• TournamentEdited

• TournamentUserJoined

• RecreationalGameCreated

• RecreationalGameJoined

• RecreationalGameCanceled

• RecreationalGameCompleted

• RecreationalGameStarted

Retrieve Existing Subscriptions

Returns a list of all existing webhook subscriptions.

GET /api/rest/webhook/configs?apiKey=your-Lucra-assigned-api-key

{
    "configs": [
        {
            "id": "109387a1-45a9-4408-8998-1c0404a0a21c",
            "name": "Free to Play Game Matchups Created",          
            "description": "Sync Game Matchups",            
            "webhookUrl": "https://test.com/lucra-game-matchups",            
            "subscriptions": [FtpMatchupCreated],            
            "active": true,
            "expirationDate": null,
            "headers": null
        }
    ]
}

Update an Existing Subscription

Update an existing webhook subscription.

PUT /api/rest/webhook/configs/:id

{
    "apiKey": "your-Lucra-assigned-api-key",
    "object": {
        "subscriptions": ["FtpMatchupCreated"],
        "webhookUrl": "https://test.com/lucra-game-matchups",
        "active": false
    }
}

Delete an Existing Subscription

Delete an existing webhook subscription.

DELETE /api/rest/webhook/configs/{webhook-uuid}?apiKey=your-Lucra-assigned-api-key