Create event type mapping

cURL

curl --request POST \
  --url https://api.mottostreaming.com/integration/spiideo/v1/event_type_mappings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "motto_event_type": "<string>",
  "home_team_field": "<string>",
  "away_team_field": "<string>",
  "scene_field": "<string>",
  "home_color_field": "<string>",
  "away_color_field": "<string>",
  "description_field": "<string>",
  "sport_field": "<string>",
  "spiideo_graphic_package_id": "<string>",
  "spiideo_storyboard_id": "<string>",
  "spiideo_production_recipe_id": "<string>",
  "home_starting_lineup_field": "<string>",
  "home_bench_lineup_field": "<string>",
  "away_starting_lineup_field": "<string>",
  "away_bench_lineup_field": "<string>",
  "lineup_number_field": "<string>",
  "competition_field": "<string>"
}
'

import requests

url = "https://api.mottostreaming.com/integration/spiideo/v1/event_type_mappings"

payload = {
    "motto_event_type": "<string>",
    "home_team_field": "<string>",
    "away_team_field": "<string>",
    "scene_field": "<string>",
    "home_color_field": "<string>",
    "away_color_field": "<string>",
    "description_field": "<string>",
    "sport_field": "<string>",
    "spiideo_graphic_package_id": "<string>",
    "spiideo_storyboard_id": "<string>",
    "spiideo_production_recipe_id": "<string>",
    "home_starting_lineup_field": "<string>",
    "home_bench_lineup_field": "<string>",
    "away_starting_lineup_field": "<string>",
    "away_bench_lineup_field": "<string>",
    "lineup_number_field": "<string>",
    "competition_field": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    motto_event_type: '<string>',
    home_team_field: '<string>',
    away_team_field: '<string>',
    scene_field: '<string>',
    home_color_field: '<string>',
    away_color_field: '<string>',
    description_field: '<string>',
    sport_field: '<string>',
    spiideo_graphic_package_id: '<string>',
    spiideo_storyboard_id: '<string>',
    spiideo_production_recipe_id: '<string>',
    home_starting_lineup_field: '<string>',
    home_bench_lineup_field: '<string>',
    away_starting_lineup_field: '<string>',
    away_bench_lineup_field: '<string>',
    lineup_number_field: '<string>',
    competition_field: '<string>'
  })
};

fetch('https://api.mottostreaming.com/integration/spiideo/v1/event_type_mappings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mottostreaming.com/integration/spiideo/v1/event_type_mappings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'motto_event_type' => '<string>',
    'home_team_field' => '<string>',
    'away_team_field' => '<string>',
    'scene_field' => '<string>',
    'home_color_field' => '<string>',
    'away_color_field' => '<string>',
    'description_field' => '<string>',
    'sport_field' => '<string>',
    'spiideo_graphic_package_id' => '<string>',
    'spiideo_storyboard_id' => '<string>',
    'spiideo_production_recipe_id' => '<string>',
    'home_starting_lineup_field' => '<string>',
    'home_bench_lineup_field' => '<string>',
    'away_starting_lineup_field' => '<string>',
    'away_bench_lineup_field' => '<string>',
    'lineup_number_field' => '<string>',
    'competition_field' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mottostreaming.com/integration/spiideo/v1/event_type_mappings"

	payload := strings.NewReader("{\n  \"motto_event_type\": \"<string>\",\n  \"home_team_field\": \"<string>\",\n  \"away_team_field\": \"<string>\",\n  \"scene_field\": \"<string>\",\n  \"home_color_field\": \"<string>\",\n  \"away_color_field\": \"<string>\",\n  \"description_field\": \"<string>\",\n  \"sport_field\": \"<string>\",\n  \"spiideo_graphic_package_id\": \"<string>\",\n  \"spiideo_storyboard_id\": \"<string>\",\n  \"spiideo_production_recipe_id\": \"<string>\",\n  \"home_starting_lineup_field\": \"<string>\",\n  \"home_bench_lineup_field\": \"<string>\",\n  \"away_starting_lineup_field\": \"<string>\",\n  \"away_bench_lineup_field\": \"<string>\",\n  \"lineup_number_field\": \"<string>\",\n  \"competition_field\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.mottostreaming.com/integration/spiideo/v1/event_type_mappings")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"motto_event_type\": \"<string>\",\n  \"home_team_field\": \"<string>\",\n  \"away_team_field\": \"<string>\",\n  \"scene_field\": \"<string>\",\n  \"home_color_field\": \"<string>\",\n  \"away_color_field\": \"<string>\",\n  \"description_field\": \"<string>\",\n  \"sport_field\": \"<string>\",\n  \"spiideo_graphic_package_id\": \"<string>\",\n  \"spiideo_storyboard_id\": \"<string>\",\n  \"spiideo_production_recipe_id\": \"<string>\",\n  \"home_starting_lineup_field\": \"<string>\",\n  \"home_bench_lineup_field\": \"<string>\",\n  \"away_starting_lineup_field\": \"<string>\",\n  \"away_bench_lineup_field\": \"<string>\",\n  \"lineup_number_field\": \"<string>\",\n  \"competition_field\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mottostreaming.com/integration/spiideo/v1/event_type_mappings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"motto_event_type\": \"<string>\",\n  \"home_team_field\": \"<string>\",\n  \"away_team_field\": \"<string>\",\n  \"scene_field\": \"<string>\",\n  \"home_color_field\": \"<string>\",\n  \"away_color_field\": \"<string>\",\n  \"description_field\": \"<string>\",\n  \"sport_field\": \"<string>\",\n  \"spiideo_graphic_package_id\": \"<string>\",\n  \"spiideo_storyboard_id\": \"<string>\",\n  \"spiideo_production_recipe_id\": \"<string>\",\n  \"home_starting_lineup_field\": \"<string>\",\n  \"home_bench_lineup_field\": \"<string>\",\n  \"away_starting_lineup_field\": \"<string>\",\n  \"away_bench_lineup_field\": \"<string>\",\n  \"lineup_number_field\": \"<string>\",\n  \"competition_field\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "event_type_mapping": {
    "motto_event_type": "<string>",
    "home_team_field": "<string>",
    "away_team_field": "<string>",
    "scene_field": "<string>",
    "home_color_field": "<string>",
    "away_color_field": "<string>",
    "description_field": "<string>",
    "sport_field": "<string>",
    "spiideo_graphic_package_id": "<string>",
    "spiideo_storyboard_id": "<string>",
    "spiideo_production_recipe_id": "<string>",
    "home_starting_lineup_field": "<string>",
    "home_bench_lineup_field": "<string>",
    "away_starting_lineup_field": "<string>",
    "away_bench_lineup_field": "<string>",
    "lineup_number_field": "<string>",
    "competition_field": "<string>"
  }
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "<string>"
    }
  ]
}

POST

integration

spiideo

event_type_mappings

cURL

curl --request POST \
  --url https://api.mottostreaming.com/integration/spiideo/v1/event_type_mappings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "motto_event_type": "<string>",
  "home_team_field": "<string>",
  "away_team_field": "<string>",
  "scene_field": "<string>",
  "home_color_field": "<string>",
  "away_color_field": "<string>",
  "description_field": "<string>",
  "sport_field": "<string>",
  "spiideo_graphic_package_id": "<string>",
  "spiideo_storyboard_id": "<string>",
  "spiideo_production_recipe_id": "<string>",
  "home_starting_lineup_field": "<string>",
  "home_bench_lineup_field": "<string>",
  "away_starting_lineup_field": "<string>",
  "away_bench_lineup_field": "<string>",
  "lineup_number_field": "<string>",
  "competition_field": "<string>"
}
'

import requests

url = "https://api.mottostreaming.com/integration/spiideo/v1/event_type_mappings"

payload = {
    "motto_event_type": "<string>",
    "home_team_field": "<string>",
    "away_team_field": "<string>",
    "scene_field": "<string>",
    "home_color_field": "<string>",
    "away_color_field": "<string>",
    "description_field": "<string>",
    "sport_field": "<string>",
    "spiideo_graphic_package_id": "<string>",
    "spiideo_storyboard_id": "<string>",
    "spiideo_production_recipe_id": "<string>",
    "home_starting_lineup_field": "<string>",
    "home_bench_lineup_field": "<string>",
    "away_starting_lineup_field": "<string>",
    "away_bench_lineup_field": "<string>",
    "lineup_number_field": "<string>",
    "competition_field": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    motto_event_type: '<string>',
    home_team_field: '<string>',
    away_team_field: '<string>',
    scene_field: '<string>',
    home_color_field: '<string>',
    away_color_field: '<string>',
    description_field: '<string>',
    sport_field: '<string>',
    spiideo_graphic_package_id: '<string>',
    spiideo_storyboard_id: '<string>',
    spiideo_production_recipe_id: '<string>',
    home_starting_lineup_field: '<string>',
    home_bench_lineup_field: '<string>',
    away_starting_lineup_field: '<string>',
    away_bench_lineup_field: '<string>',
    lineup_number_field: '<string>',
    competition_field: '<string>'
  })
};

fetch('https://api.mottostreaming.com/integration/spiideo/v1/event_type_mappings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mottostreaming.com/integration/spiideo/v1/event_type_mappings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'motto_event_type' => '<string>',
    'home_team_field' => '<string>',
    'away_team_field' => '<string>',
    'scene_field' => '<string>',
    'home_color_field' => '<string>',
    'away_color_field' => '<string>',
    'description_field' => '<string>',
    'sport_field' => '<string>',
    'spiideo_graphic_package_id' => '<string>',
    'spiideo_storyboard_id' => '<string>',
    'spiideo_production_recipe_id' => '<string>',
    'home_starting_lineup_field' => '<string>',
    'home_bench_lineup_field' => '<string>',
    'away_starting_lineup_field' => '<string>',
    'away_bench_lineup_field' => '<string>',
    'lineup_number_field' => '<string>',
    'competition_field' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mottostreaming.com/integration/spiideo/v1/event_type_mappings"

	payload := strings.NewReader("{\n  \"motto_event_type\": \"<string>\",\n  \"home_team_field\": \"<string>\",\n  \"away_team_field\": \"<string>\",\n  \"scene_field\": \"<string>\",\n  \"home_color_field\": \"<string>\",\n  \"away_color_field\": \"<string>\",\n  \"description_field\": \"<string>\",\n  \"sport_field\": \"<string>\",\n  \"spiideo_graphic_package_id\": \"<string>\",\n  \"spiideo_storyboard_id\": \"<string>\",\n  \"spiideo_production_recipe_id\": \"<string>\",\n  \"home_starting_lineup_field\": \"<string>\",\n  \"home_bench_lineup_field\": \"<string>\",\n  \"away_starting_lineup_field\": \"<string>\",\n  \"away_bench_lineup_field\": \"<string>\",\n  \"lineup_number_field\": \"<string>\",\n  \"competition_field\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.mottostreaming.com/integration/spiideo/v1/event_type_mappings")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"motto_event_type\": \"<string>\",\n  \"home_team_field\": \"<string>\",\n  \"away_team_field\": \"<string>\",\n  \"scene_field\": \"<string>\",\n  \"home_color_field\": \"<string>\",\n  \"away_color_field\": \"<string>\",\n  \"description_field\": \"<string>\",\n  \"sport_field\": \"<string>\",\n  \"spiideo_graphic_package_id\": \"<string>\",\n  \"spiideo_storyboard_id\": \"<string>\",\n  \"spiideo_production_recipe_id\": \"<string>\",\n  \"home_starting_lineup_field\": \"<string>\",\n  \"home_bench_lineup_field\": \"<string>\",\n  \"away_starting_lineup_field\": \"<string>\",\n  \"away_bench_lineup_field\": \"<string>\",\n  \"lineup_number_field\": \"<string>\",\n  \"competition_field\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mottostreaming.com/integration/spiideo/v1/event_type_mappings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"motto_event_type\": \"<string>\",\n  \"home_team_field\": \"<string>\",\n  \"away_team_field\": \"<string>\",\n  \"scene_field\": \"<string>\",\n  \"home_color_field\": \"<string>\",\n  \"away_color_field\": \"<string>\",\n  \"description_field\": \"<string>\",\n  \"sport_field\": \"<string>\",\n  \"spiideo_graphic_package_id\": \"<string>\",\n  \"spiideo_storyboard_id\": \"<string>\",\n  \"spiideo_production_recipe_id\": \"<string>\",\n  \"home_starting_lineup_field\": \"<string>\",\n  \"home_bench_lineup_field\": \"<string>\",\n  \"away_starting_lineup_field\": \"<string>\",\n  \"away_bench_lineup_field\": \"<string>\",\n  \"lineup_number_field\": \"<string>\",\n  \"competition_field\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "event_type_mapping": {
    "motto_event_type": "<string>",
    "home_team_field": "<string>",
    "away_team_field": "<string>",
    "scene_field": "<string>",
    "home_color_field": "<string>",
    "away_color_field": "<string>",
    "description_field": "<string>",
    "sport_field": "<string>",
    "spiideo_graphic_package_id": "<string>",
    "spiideo_storyboard_id": "<string>",
    "spiideo_production_recipe_id": "<string>",
    "home_starting_lineup_field": "<string>",
    "home_bench_lineup_field": "<string>",
    "away_starting_lineup_field": "<string>",
    "away_bench_lineup_field": "<string>",
    "lineup_number_field": "<string>",
    "competition_field": "<string>"
  }
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

project_id

string

required

Body

application/json

SpiideoEventTypeMapping maps a Motto event type to Spiideo event properties.

motto_event_type

string

required

The Motto event type this mapping applies to.

home_team_field

string

required

Field name on the Motto event type that maps to the home team. This has to be an entity reference. E.g. fields.home_team

away_team_field

string

required

Field name on the Motto event type that maps to the away team. This has to be an entity reference. E.g. fields.away_team

scene_field

string

required

Field name on the Motto event type that maps to the scene/venue. This has to be an entity reference. E.g. fields.stadium or fields.venue

home_color_field

string

required

Field name on the Motto event type that maps to the home team color. This has to be a string field that contains a color value, e.g. "#FF0000" for red. E.g. fields.home_color

away_color_field

string

required

Field name on the Motto event type that maps to the away team color. This has to be a string field that contains a color value, e.g. "#0000FF" for blue. E.g. fields.away_color

description_field

string

required

Field name on the Motto event that maps to the Spiideo game description, which shows above the scoreboard in the Spiideo streams. This must be an entity reference OR a string field. E.g. fields.competition (in which case the name of the referenced competition will be the description) E.g. description or fields.some_custom_description (in which case the value of the field will be the description)

sport_field

string

Field name on the Motto event type that maps to the sport. This has to be an entity reference OR if it matches exactly the Spiideo sport enum values, a string field, E.g. fields.sport (which may be an entity reference) E.g. fields.sport_type (which may be resolve to a string field with values like "football", "basketball", etc.) E.g. football (a hard-coded string field, instead of a resolvable field keypath).

If not set, there are two alternative ways to indicate which sport should be used when an event of this type is created:

The Spiideo sport configured on the TeamTypeMapping. This means the sport will be taken from the home team on the event.
The Spiideo sport configured on the SpiideoIntegration. This is a last resort, if no other sport can be determined.

spiideo_graphic_package_id

string

The Spiideo graphic package ID to use for any Spiideo game object created for this event type. Required, unless using the production recipe ID.

spiideo_storyboard_id

string

The Spiideo storyboard ID to use for any Spiideo game object created for this event type. Required, unless using the production recipe ID.

spiideo_production_recipe_id

string

The Spiideo production recipe ID to use for any Spiideo game object created for this event type. Required, unless using the graphic package ID and storyboard ID.

home_starting_lineup_field

string

Field name on the Motto event type that maps to the starting lineup of the home team. This has to be a repeated entity reference to player entities. E.g. fields.home_starting_players

If not set, no Spiideo participants will be created for the home team of games of this event type.

home_bench_lineup_field

string

Field name on the Motto event type that maps to the bench (substitute) players of the home team. This has to be a repeated entity reference to player entities. E.g. fields.home_bench_players

away_starting_lineup_field

string

Field name on the Motto event type that maps to the starting lineup of the away team. This has to be a repeated entity reference to player entities. E.g. fields.away_starting_players

If not set, no Spiideo participants will be created for the away team of games of this event type.

away_bench_lineup_field

string

Field name on the Motto event type that maps to the bench (substitute) players of the away team. This has to be a repeated entity reference to player entities. E.g. fields.away_bench_players

lineup_number_field

string

The name of the additional field within each lineup entity reference that holds the player's jersey number. E.g. jersey_number, in which case each entry of a lineup field is expected to look like {"base_type":"entity","id":"<player entity id>","jersey_number":"8","type_id":"player"}.

If not set, no jersey numbers will be set on the Spiideo participants.

competition_field

string

Field name on the Motto event type that maps to the competition (one season of a competition series) the event belongs to. This has to be an entity reference to an entity that is mapped to a Spiideo competition. E.g. fields.season or fields.competition

If not set, no Spiideo event (fixture) will be created for games of this event type, even when sync_fixtures is enabled on the SpiideoIntegration.

Response

event_type_mapping

object

SpiideoEventTypeMapping maps a Motto event type to Spiideo event properties.

Show child attributes

Get Started

Studio API

Content Delivery API

Deep dive

Create event type mapping

Authorizations

Query Parameters

Body

Response