MUmuxinc

POST Webhook robots.v1.job.generate_chapters.errored

Payload

type'robots.v1.job.generate_chapters.errored' 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",
      "update_asset_chapters": true,
      "output_steering": {
        "chapter_style": "descriptive",
        "chapter_granularity": "balanced",
        "audience": "Developers"
      }
    },
    "resources": {
      "assets": [
        {
          "id": "abc123asset",
          "meta": {
            "title": "My Video",
            "creator_id": "user123",
            "external_id": "ext456"
          },
          "_links": {
            "self": {
              "href": "/video/v1/assets/abc123asset"
            }
          }
        }
      ]
    },
    "outputs": {
      "chapters": [
        {
          "start_time": 0,
          "title": "Introduction"
        }
      ],
      "asset_updates": {
        "chapters": {
          "status": "created",
          "track_id": "chaptersabc123def456",
          "replaced_track_ids": [
            "old_chapters_track"
          ]
        }
      }
    }
  }
}

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.