Events

Register the URL for the game to receive notifications

Register the URL for the game to receive notifications

POST/v1/webhook

Header parameters

Body

application/json

urlstring (string)

url to send service events to

authorizationHeaderNamestring (string)

header name to pass for authorization (if any)

authorizationKeystring (string)

authorization header value (if any)

Response

200

Success

Body

application/json

urlstring (string)

url to send service events to

authorizationHeaderNamestring (string)

header name to pass for authorization (if any)

authorizationKeystring (string)

authorization header value (if any)

Request

JavaScriptCurlPython

const response = await fetch('/v1/webhook', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "x-mythical-environment-id": "123e4567-e89b-12d3-a456-426614174000",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "url": "http://url.com/webhook",
      "authorizationHeaderName": "Authorization",
      "authorizationKey": "Bearer jwt"
    }),
});
const data = await response.json();

Response

200

{
  "url": "http://url.com/webhook",
  "authorizationHeaderName": "Authorization",
  "authorizationKey": "Bearer jwt"
}

Update the URL for the game to receive notifications

Update the URL for the game to receive notifications

PUT/v1/webhook

Header parameters

Body

application/json

urlstring (string)

url to send service events to

authorizationHeaderNamestring (string)

header name to pass for authorization (if any)

authorizationKeystring (string)

authorization header value (if any)

Response

200

Success

Body

application/json

urlstring (string)

url to send service events to

authorizationHeaderNamestring (string)

header name to pass for authorization (if any)

authorizationKeystring (string)

authorization header value (if any)

Request

JavaScriptCurlPython

const response = await fetch('/v1/webhook', {
    method: 'PUT',
    headers: {
      "Authorization": "text",
      "x-mythical-environment-id": "123e4567-e89b-12d3-a456-426614174000",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "url": "http://url.com/webhook",
      "authorizationHeaderName": "Authorization",
      "authorizationKey": "Bearer jwt"
    }),
});
const data = await response.json();

Response

200

{
  "url": "http://url.com/webhook",
  "authorizationHeaderName": "Authorization",
  "authorizationKey": "Bearer jwt"
}

Remove the URL for the game to receive notifications

Remove the URL for the game to receive notifications

DELETE/v1/webhook

Header parameters

Response

200

Success

Request

JavaScriptCurlPython

const response = await fetch('/v1/webhook', {
    method: 'DELETE',
    headers: {
      "Authorization": "text",
      "x-mythical-environment-id": "123e4567-e89b-12d3-a456-426614174000"
    },
});
const data = await response.json();