Mythical Platform
Mythical Platform
  • The Mythical Platform API
  • Quick start
    • Authenticate
    • Create a guest player
    • Create an item type
    • Grant an item to a player
    • Update item metadata
    • Use webhooks for real time messages
    • Buy a listed item
  • API Reference
    • Players
    • Item Types
    • Items
    • Marketplace
      • Listings
      • Offers
      • Quick trade
      • Transaction history
      • Exchange rate
      • Check status of transaction
    • Events
    • System
Powered by GitBook
On this page
  1. API Reference

Events

PreviousCheck status of transactionNextSystem

Last updated 4 months ago

Register the URL for the game to receive notifications

Register the URL for the game to receive notifications

post

/v1/webhook

Authorizations
Header parameters
Authorizationstring · Bearer {bearerToken}required

Bearer token to be passed for Authorization. Can be retrieved from v1/auth/token

x-mythical-environment-idstring · uuidrequired

Identifier for the environment that this request should interact with

Body
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)

Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url '/v1/webhook' \
  --header 'Authorization: text' \
  --header 'x-mythical-environment-id: 123e4567-e89b-12d3-a456-426614174000' \
  --header 'Content-Type: application/json' \
  --data '{
    "url": "http://url.com/webhook",
    "authorizationHeaderName": "Authorization",
    "authorizationKey": "Bearer jwt"
  }'
200
{
  "url": "http://url.com/webhook",
  "authorizationHeaderName": "Authorization",
  "authorizationKey": "Bearer jwt"
}

Success

Update the URL for the game to receive notifications

Update the URL for the game to receive notifications

put

/v1/webhook

Authorizations
Header parameters
Authorizationstring · Bearer {bearerToken}required

Bearer token to be passed for Authorization. Can be retrieved from v1/auth/token

x-mythical-environment-idstring · uuidrequired

Identifier for the environment that this request should interact with

Body
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)

Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request PUT \
  --url '/v1/webhook' \
  --header 'Authorization: text' \
  --header 'x-mythical-environment-id: 123e4567-e89b-12d3-a456-426614174000' \
  --header 'Content-Type: application/json' \
  --data '{
    "url": "http://url.com/webhook",
    "authorizationHeaderName": "Authorization",
    "authorizationKey": "Bearer jwt"
  }'
200
{
  "url": "http://url.com/webhook",
  "authorizationHeaderName": "Authorization",
  "authorizationKey": "Bearer jwt"
}

Success

Remove the URL for the game to receive notifications

Remove the URL for the game to receive notifications

delete

/v1/webhook

Authorizations
Header parameters
Authorizationstring · Bearer {bearerToken}required

Bearer token to be passed for Authorization. Can be retrieved from v1/auth/token

x-mythical-environment-idstring · uuidrequired

Identifier for the environment that this request should interact with

Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --request DELETE \
  --url '/v1/webhook' \
  --header 'Authorization: text' \
  --header 'x-mythical-environment-id: 123e4567-e89b-12d3-a456-426614174000'
200
No body

Success

  • POSTRegister the URL for the game to receive notifications
  • PUTUpdate the URL for the game to receive notifications
  • DELETERemove the URL for the game to receive notifications