Example JSON payloads

Notifications

Messaging.NotificationMessage

{
  "context": "contentScopeScripts",
  "featureName": "duckPlayer",
  "method": "saveUserValues"
}
Copy

Messaging.NotificationMessage with params

{
  "context": "contentScopeScripts",
  "featureName": "duckPlayer",
  "method": "saveUserValues",
  "params": { "hello": "world" }
}
Copy

Messaging.NotificationMessage with invalid params

{
  "context": "contentScopeScripts",
  "featureName": "duckPlayer",
  "method": "getUserValues",
  "params": "oops! <- cannot be a string/number/boolean/null"
}
Copy

Requests

Messaging.RequestMessage

{
  "context": "contentScopeScripts",
  "featureName": "duckPlayer",
  "method": "getUserValues",
  "id": "abc123"
}
Copy

Messaging.RequestMessage with params

{
  "context": "contentScopeScripts",
  "featureName": "duckPlayer",
  "method": "getUserValues",
  "params": { "hello": "world" },
  "id": "abc123"
}
Copy

Messaging.RequestMessage with invalid params

{
  "context": "contentScopeScripts",
  "featureName": "duckPlayer",
  "method": "getUserValues",
  "params": "oops! <- cannot be a string/number/boolean/null",
  "id": "abc123"
}
Copy

Responses

Messaging.MessageResponse with data

{
  "context": "contentScopeScripts",
  "featureName": "duckPlayer",
  "id": "abc123",
  "result": { "hello":  "world" }
}
Copy

Error Response

Messaging.MessageResponse with error

{
  "context": "contentScopeScripts",
  "featureName": "duckPlayer",
  "id": "abc123",
  "error": {
    "message": "Method not found"
  }
}
Copy

Subscriptions

Messaging.SubscriptionEvent without data

{
  "context": "contentScopeScripts",
  "featureName": "duckPlayer",
  "subscriptionName": "onUserValuesUpdated"
}
Copy

Messaging.SubscriptionEvent with data

{
  "context": "contentScopeScripts",
  "featureName": "duckPlayer",
  "subscriptionName": "onUserValuesUpdated",
  "params": { "hello":  "world" }
}
Copy