MUmuxinc

POST Webhook robots.v1.job.analyze_structure.pending

Payload

type'robots.v1.job.analyze_structure.pending' required

Type for the webhook event

idstring required

Unique identifier for the event

created_atstring date-time required

Time the event was created

Example payload

{
  "created_at": "2022-01-01T00:00:00.000000Z",
  "attempts": [
    {
      "created_at": "2022-01-01T00:00:00.000000Z"
    }
  ],
  "data": {
    "parameters": {
      "asset_id": "mux_asset_123abc",
      "language_code": "en",
      "output_language_code": "en",
      "output_steering": {
        "scope": {
          "start_time": 30,
          "end_time": 300
        },
        "audience": "Developers evaluating video APIs",
        "brand_terms": [
          "Mux",
          "Mux Data"
        ],
        "granularity": "balanced"
      },
      "update_asset_meta": true,
      "update_asset_chapters": true
    },
    "resources": {
      "assets": [
        {
          "id": "abc123asset",
          "meta": {
            "title": "My Video",
            "creator_id": "user123",
            "external_id": "ext456"
          },
          "_links": {
            "self": {
              "href": "/video/v1/assets/abc123asset"
            }
          }
        }
      ]
    },
    "outputs": {
      "title": "A product demonstration",
      "summary": "A presenter explains the product.",
      "tags": [
        "product demo"
      ],
      "chapters": [
        {
          "start_time": 23.456,
          "end_time": 45.678,
          "title": "Demonstration"
        }
      ],
      "scenes": [],
      "key_moments": []
    }
  }
}

Response

Return a 200 to indicate that the data was received successfully

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.