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
    • Webhook management
    • System
Powered by GitBook
On this page
  1. API Reference

Webhook management

PreviousExchange rateNextSystem

Last updated 1 month ago

Related content:

Webhooks structure and how to use

Remove the URL for the game to receive notifications

delete

Remove the URL for the game to receive notifications

Authorizations
Header parameters
x-mythical-environment-idstring · uuidRequired

Identifier for the environment that this request should interact with

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

Success

No content
  • 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

Register the URL for the game to receive notifications

post

Register the URL for the game to receive notifications

Authorizations
Header parameters
x-mythical-environment-idstring · uuidRequired

Identifier for the environment that this request should interact with

Body
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
POST /v1/webhook HTTP/1.1
Host: 
Authorization: Bearer JWT
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
Header parameters
x-mythical-environment-idstring · uuidRequired

Identifier for the environment that this request should interact with

Body
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
PUT /v1/webhook HTTP/1.1
Host: 
Authorization: Bearer JWT
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"
}