Webhook

newPlanet

​

Body·

application/json

Information about a new planet

A planet in the Scalar Galaxy

  • name
    Type: string
    required
  • atmosphere
    Type: array of object

    Atmospheric composition

    Properties: 3
  • creator
    Type:

    A user

    Properties: 1
  • description
    Type: string | null
  • discoveredAt
    Type: stringFormat: date-time

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • failureCallbackUrl
    Type: stringFormat: uri

    URL which gets invoked upon a failed operation

  • habitabilityIndex
    Type: numberFormat: float
    min:  
    0
    max:  
    1

    A score from 0 to 1 indicating potential habitability

  • image
    Type: string | null
  • physicalProperties
    Type: object
    Properties: 5
  • satellites
    Type:
    Properties: 5
  • successCallbackUrl
    Type: stringFormat: uri

    URL which gets invoked upon a successful operation

  • tags
    Type: array of string

Responses

  • 200

    Return a 200 status to indicate that the data was received successfully

Request Example for postnewPlanet
{
  "name": "Mars",
  "description": "The red planet",
  "type": "terrestrial",
  "habitabilityIndex": 0.68,
  "physicalProperties": {
    "mass": 0.107,
    "radius": 0.532,
    "gravity": 0.378,
    "temperature": {
      "min": 130,
      "max": 308,
      "average": 210,
      "temperatureMetric": 1
    },
    "measurement": 1
  },
  "atmosphere": [
    {
      "compound": "CO2",
      "percentage": 95.3,
      "atmosphericData": ""
    }
  ],
  "discoveredAt": "1610-01-07T00:00:00Z",
  "image": "https://cdn.scalar.com/photos/mars.jpg",
  "satellites": [
    {
      "name": "Phobos",
      "description": "Phobos is the larger and innermost of the two moons of Mars.",
      "diameter": 22.2,
      "type": "moon",
      "orbit": {
        "planet": null,
        "orbitalPeriod": 0.319,
        "distance": 9376
      }
    }
  ],
  "creator": {
    "name": "Marc"
  },
  "tags": [
    "solar-system",
    "rocky",
    "explored"
  ],
  "successCallbackUrl": "https://example.com/webhook",
  "failureCallbackUrl": "https://example.com/webhook"
}
No Body

Return a 200 status to indicate that the data was received successfully