Replay Assembly Notification

Replays an Assembly Notification, sending the POST request containing the Assembly result JSON again to the notify_url that was specified when the Assembly was created.

POST fields

• Passing signature is required. For more information, please check Signature Authentication.
• Passing params is required. It should contain a JSON encoded object with the keys as shown in the table below.

Supported keys inside the params field

• auth — required

  object

  Contains at least your Transloadit Auth Key in the key property.

  If you enable Signature Authentication, you must also set an expiry date for the request in the expires property:

  

  {
    "key": "23c96d084c744219a2ce156772ec3211",
    "expires": "2009-08-28T01:02:03.000Z"
  }
  

  We strongly recommend including the nonce property — a randomly generated, unique value per request that prevents duplicate processing upon retries, can aid in debugging, and avoids attack vectors such as signature key reuse:

  

  {
    // …
    "nonce": "04ac6cb6-df43-41fb-a7fd-e5dd711a64e1"
  }
  

  The referer property is a regular expression to match against the HTTP referer of this upload, such as "example\.org". Specify this key to make sure that uploads only come from your domain.

  Uploads without a referer will always pass (as they are turned off for some browsers) making this useful in just a handful of use cases. For details about regular expressions, see Mozilla's RegExp documentation.

  The max_size property can be used to set a maximum size that an upload can have in bytes, such as 1048576 (1 MB). Specify this to prevent users from uploading excessively large files.

  This can be set as part of the Assembly request or as part of the Template.

  The file size is checked as soon as the upload is started and if it exceeds the maximum size, the entire upload process is canceled and the Assembly will error out, even if it contains files that do not exceed the max_size limitation.

  If you want to just ignore the files that exceed a certain size, but process all others, then please use 🤖/file/filter.

• steps

  Record<string, object & object>

  Contains Assembly Instructions.

• wait

  boolean (default: true)

  If it is provided with the value false, then the API request will return immediately even though the Notification is still in progress. This can be useful if your server takes some time to respond, but you do not want the replay API request to hang.

Response

Here’s an example response body:

{
  "ok": "ASSEMBLY_REPLAYING"
}

Either returns with the success code ASSEMBLY_NOTIFICATION_REPLAYED or with the proper error code detailing what went wrong.

If waitForEncoding was set to false, the success code will be ASSEMBLY_NOTIFICATION_REPLAYING.