Configuration APIs

The Alpha Engine Configuration API offers you a set of endpoints that allows you to manage your organization related activities i.e webhook secret and registration.

Prerequisites:

You need an API key, which serves as your access token to Alpha Engine's APIs.

Setting up Webhook

Request Endpoint:

1PUT {{BASE_URL}}/organizations/{{organization}}

Request Body:

1{
2    "webhook" : {
3        "url" : "https://example.com/webhooks/alpha-engine",
4        "secret" : "AmazingWebhook@Secret$z"
5    }
6}

After successfully updating your webhook endpoint, you'll be able to receive following events

  1. Contract Deployment
  2. Batch Mint Tokens

Response:

1{
2  payload: any
3  action: 'deployment' | 'batch-mint'
4  type: 'token' | 'contract'
5  organization: 'string'
6}