Skip to main content

Embed One-Click Report

This document contains information for a one-click report initiated when creating a user farm on Embed.

  • Embed ID
  • DAS Farm ID
  • One-click report URL

Schema​

{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "title": "Embed One-click Report Webhook Schema",
    "type": "object",
    "required": [
      "embedId",
      "dasFarmId",
      "oneClickReportUrl"
    ],
    "properties": {
      "embedId": {
        "title": "A unique identifier for a user farm in the DAS Embed application",
        "type": "string"
      },
      "dasFarmId": {
        "title": "A unique identifier for a user farm in the DAS Rural Platform application",
        "type": "string"
      },
      "oneClickReportUrl": {
        "title": "One-click Report URL",
        "description": "Contains a link to download a one-click PDF report. It is an S3 pre-signed URL that expires 6.5 days from the time it is generated.",
        "type": "string",
        "format": "uri"
      }
    }
}

Example​

{
    "$schema": "https://developers.dasintel.io/embed/json/one-click-report-webhook-schema.json",
    "embedId": "3e8cbbcf-0b85-4111-8ca9-6fd424697f6b",
    "dasFarmId": "0813ee1b-4e97-4a96-b44c-9698b9b714e5",
    "oneClickReportUrl": "https://ap-southeast-2-production-app-user-data-cdk-managed.s3.dualstack.ap-southeast-2.amazonaws.com/1ce7cd13fd1a9d480da02f9be1ca4633/pdf/1739927394-.pdf?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAWPTEQVWQN3QKWU4H%2F20250219%2Fap-southeast-2%2Fs3%2Faws4_request&X-Amz-Date=20250219T011021Z&X-Amz-SignedHeaders=host&X-Amz-Expires=561600&X-Amz-Signature=66fb708c7dfc4b3f3debe1f1b353bf10001f728125a5ad87054c538a555b8b56"
}