asset_exported

Exports are generated asynchronously, so subscribe to this event instead of polling the export request.

relationships.object.data identifies the export request, and included contains it. Check its status: success means url links to the file, failure means the export failed and url is null.

The url is a signed link that expires 15 minutes after the event was created, and a retried delivery carries the same link. If it has expired, retrieve the export request from the API to get a fresh one.

The payload below is the default JSON:API document. The webhook's payload_include, payload_fields and payload_transformation_template change it, and its filter decides whether the event is sent at all.

Request

We send the event to your webhook's url with POST (or the webhook's http_method) and a JSON:API document as the body (Content-Type: application/vnd.api+json). See Receiving Webhooks for retries and Webhook Event Signatures to verify the request.

Headers

Payload

Included resources

The sideloaded resources: the export request.

asset_export_request

An export of assets, generated asynchronously as a ZIP file.

Example

{
  "data": {
    "id": "1377464",
    "type": "event",
    "attributes": {
      "created_at": "2025-03-14T16:42:07.000Z",
      "name": "asset_exported"
    },
    "relationships": {
      "object": {
        "data": {
          "type": "asset_export_request",
          "id": "Q2kHzGx9aBcD1g"
        }
      },
      "team": {
        "data": {
          "type": "team",
          "id": "1"
        }
      }
    }
  },
  "included": [
    {
      "id": "Q2kHzGx9aBcD1g",
      "type": "asset_export_request",
      "attributes": {
        "status": "success",
        "url": "https://exports.example.com/Q2kHzGx9aBcD1g.zip?X-Amz-Expires=900&X-Amz-Signature=5d41402abc4b2a76"
      },
      "relationships": {
        "user": {
          "meta": {
            "included": false
          }
        }
      }
    }
  ]
}

Responses