Webhook management

Register the URL for the game to receive notifications

post

Register the URL for the game to receive notifications

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

x-mythical-environment-idstring · uuidRequired

Identifier for the environment that this request should interact with

Body

application/json

urlstring · stringRequired

url to send service events to

authorizationHeaderNamestring · stringOptional

header name to pass for authorization (if any)

authorizationKeystring · stringOptional

authorization header value (if any)

Responses

200

Success

application/json

post

/v1/webhook

HTTPcURLJavaScriptPython

POST /v1/webhook HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
x-mythical-environment-id: 123e4567-e89b-12d3-a456-426614174000
Content-Type: application/json
Accept: */*
Content-Length: 106

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

200

Success

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

Update the URL for the game to receive notifications

put

Update the URL for the game to receive notifications

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

x-mythical-environment-idstring · uuidRequired

Identifier for the environment that this request should interact with

Body

application/json

urlstring · stringRequired

url to send service events to

authorizationHeaderNamestring · stringOptional

header name to pass for authorization (if any)

authorizationKeystring · stringOptional

authorization header value (if any)

Responses

200

Success

application/json

put

/v1/webhook

HTTPcURLJavaScriptPython

PUT /v1/webhook HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
x-mythical-environment-id: 123e4567-e89b-12d3-a456-426614174000
Content-Type: application/json
Accept: */*
Content-Length: 106

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

200

Success

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

Remove the URL for the game to receive notifications

delete

Remove the URL for the game to receive notifications

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

x-mythical-environment-idstring · uuidRequired

Identifier for the environment that this request should interact with

Responses

204

Success

delete

/v1/webhook

HTTPcURLJavaScriptPython

DELETE /v1/webhook HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
x-mythical-environment-id: 123e4567-e89b-12d3-a456-426614174000
Accept: */*

204

Success

No content

Related content: Webhooks structure and how to use