---
title: "Send Agreements From Zoho Creator and Flow"
description: "Create SignatureAPI envelopes from a Zoho Deluge invokeurl call, and receive signing events with a Zoho Flow webhook trigger."
canonical: "https://signatureapi.com/docs/integrations/zoho"
source: "https://signatureapi.com/docs/integrations/zoho.md"
last_verified_api_version: "1.18.0"
---

# Send Agreements From Zoho Creator and Flow

Create SignatureAPI envelopes from a Zoho Deluge invokeurl call, and receive signing events with a Zoho Flow webhook trigger.

_Last verified against API version 1.18.0._

Zoho's Deluge scripting language calls the SignatureAPI REST API with its own `invokeurl` task, so a Creator form or a Flow custom function can send an envelope. A **Webhook** trigger in Zoho Flow receives the result. No SignatureAPI app is needed.

## Before you start

- A SignatureAPI [test API key](https://signatureapi.com/docs/api/test-mode) (it starts with `key_test_`).
- The document you send, at a URL on a [supported host](https://signatureapi.com/docs/api/resources/documents/url#external-store), or [uploaded to SignatureAPI](https://signatureapi.com/docs/api/resources/uploads/create) first. The examples use a sample PDF.
- Zoho Creator 6 if you use a Creator custom connector, which Zoho documents as [available only in C6](https://help.zoho.com/portal/en/kb/creator/developer-guide/microservices/understand-connections/articles/create-custom-connector).

## Send the envelope

1. **Store the key in a connection**

   In Creator, open the **Microservices** tab, click **+Create New**, choose **Connection** and then **Create New Custom Connector**. Choose the **API Key** authentication type, set the **Parameter Key** to `X-API-Key` and the **Parameter Location** to **Header**. Zoho sends the stored key with each `invokeurl` call that uses the connection, so the key stays out of your script.

2. **Run the script when a record is saved**

   Add a Deluge script to the **On success** action of a form, with **Successful form submission** as the trigger ([Zoho Creator help](https://help.zoho.com/portal/en/kb/creator/developer-guide/workflows/create-and-manage-on-success-action/articles/configure-deluge-script-on-success-action)). Set a criteria so the script runs once per record.

3. **Call invokeurl**

   Set `type` to `POST`, send the JSON text in `body`, and set the `Content-Type` header to match it. Zoho requires the header to match the body format, and you can't set both `parameters` and `body` in one call ([Deluge reference](https://www.zoho.com/deluge/help/webhook/invokeurl-api-task.html)). Replace `signatureapi` with the link name of your connection.

```text
// payload: a map with the request body below, filled from your form fields
headers = Map();
headers.put("Content-Type", "application/json");
response = invokeurl
[
    url: "https://api.signatureapi.com/v1/envelopes"
    type: POST
    body: payload.toString()
    headers: headers
    connection: "signatureapi"
];
info response.get("id");
```

Zoho HTTP request step settings for the "Service agreement" request:

1. **Method**: POST
2. **URL**: `https://api.signatureapi.com/v1/envelopes`

   The API key comes from the setup in the steps above, so the step needs no header row for it.
3. **Header**: `Content-Type: application/json`
4. **Body (raw JSON)**:

   ```json
   {
     "title": "Service Agreement - Jane Doe",
     "message": "Please review and sign the service agreement.",
     "metadata": {
       "source": "zoho",
       "record_id": "4876876000000123001"
     },
     "topics": [
       "no_code",
       "zoho"
     ],
     "documents": [
       {
         "key": "service_agreement",
         "url": "https://pub-9cb75390636c4a8a83a6f76da33d7f45.r2.dev/docs-samples/service-agreement.pdf",
         "format": "pdf",
         "fixed_positions": [
           {
             "place_key": "signer_signature",
             "page": 1,
             "top": 172,
             "left": 210
           }
         ],
         "places": [
           {
             "key": "signer_signature",
             "type": "signature",
             "recipient_key": "signer"
           }
         ]
       }
     ],
     "recipients": [
       {
         "type": "signer",
         "key": "signer",
         "name": "Jane Doe",
         "email": "jane.doe@example.com"
       }
     ]
   }
   ```

`data.envelope_metadata.record_id` comes back in every webhook event for this envelope, and the `zoho` topic lets an endpoint receive only these envelopes. Zoho stops an `invokeurl` call that takes more than 40 seconds.

> **Note:** Zoho shares Flow custom functions with everyone in the organization, so never write the key into one. Use a connection for it, as in Creator.

## Get the result back

1. **Create a webhook trigger**

   In **My Flows**, click **Create Flow**, select **Webhook** as the trigger, choose **JSON** as the payload format, and copy the URL Zoho Flow generates ([Zoho Flow help](https://help.zoho.com/portal/en/kb/flow/user-guide/create-a-flow/typesoftriggers/articles/webhook-trigger-typesoftriggers)).

2. **Register the URL in SignatureAPI**

   In the Dashboard, add a [webhook endpoint](https://signatureapi.com/docs/api/guides/how-to/set-up-webhooks) in test mode with that URL. Subscribe to [`deliverable.generated`](https://signatureapi.com/docs/api/resources/events/deliverable-events#deliverablegenerated), which fires when the signed PDF is ready, and add the `zoho` topic. The [`envelope.completed`](https://signatureapi.com/docs/api/resources/events/envelope-events#envelopecompleted) event comes earlier, while the PDF may still be generating, so use it only to update a status. Zoho Flow waits for a sample request to show the payload, so complete a test envelope to send one.

3. **Read the envelope before you act**

   Anyone who knows the webhook URL can call it, so read the envelope with your key before you update a record. Add a [custom function](https://help.zoho.com/portal/en/kb/flow/user-guide/create-a-flow/actions-logic/articles/using-custom-functions) that calls `invokeurl` with `type: GET`, a connection that holds the key, and `data.envelope_id` from the event in the URL:

   Zoho HTTP request step settings for the "Completed envelope" request:

   1. **Method**: GET
   2. **URL**: `https://api.signatureapi.com/v1/envelopes/eb4cf433-a8af-4161-b37b-7ef57d423e56`

      The API key comes from the setup in the steps above, so the step needs no header row for it.

   Act on the response: `deliverable.status` is `generated`, `metadata.record_id` names your record, and `deliverable.url` downloads the signed PDF. That link expires after an hour. If your account uses [authenticated deliverable URLs](https://signatureapi.com/docs/api/resources/deliverables/object#url), send your API key with the download.

Under **Advanced settings**, **Enable webhook acknowledgement** lets you set the reply. SignatureAPI expects a `2XX` answer and retries a failed delivery for up to 48 hours. The same event can arrive twice, so skip a record that already shows as signed. See [Webhooks](https://signatureapi.com/docs/api/webhooks).

## Related

- [Create an envelope](https://signatureapi.com/docs/api/resources/envelopes/create): every field of the request body.
- [Organize with topics and metadata](https://signatureapi.com/docs/api/guides/how-to/organize-topics-metadata).
- [Make](https://signatureapi.com/docs/integrations/make), [Zapier](https://signatureapi.com/docs/integrations/zapier/http-recipe) and [n8n](https://signatureapi.com/docs/integrations/n8n) use the same request.

### Example: Service agreement

Sent from a Zoho Deluge invokeurl call.

```http
POST /v1/envelopes HTTP/1.1
Host: api.signatureapi.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json

{
  "title": "Service Agreement - Jane Doe",
  "message": "Please review and sign the service agreement.",
  "metadata": {
    "source": "zoho",
    "record_id": "4876876000000123001"
  },
  "topics": [
    "no_code",
    "zoho"
  ],
  "documents": [
    {
      "key": "service_agreement",
      "url": "https://pub-9cb75390636c4a8a83a6f76da33d7f45.r2.dev/docs-samples/service-agreement.pdf",
      "format": "pdf",
      "fixed_positions": [
        {
          "place_key": "signer_signature",
          "page": 1,
          "top": 172,
          "left": 210
        }
      ],
      "places": [
        {
          "key": "signer_signature",
          "type": "signature",
          "recipient_key": "signer"
        }
      ]
    }
  ],
  "recipients": [
    {
      "type": "signer",
      "key": "signer",
      "name": "Jane Doe",
      "email": "jane.doe@example.com"
    }
  ]
}
```

Response 201 Created:

```json
{
  "id": "eb4cf433-a8af-4161-b37b-7ef57d423e56",
  "title": "Service Agreement - Jane Doe",
  "label": null,
  "message": "Please review and sign the service agreement.",
  "status": "processing",
  "attestation": "none",
  "language": "en",
  "mode": "test",
  "routing": "sequential",
  "timezone": "UTC",
  "timestamp_format": "MM/DD/YYYY HH:mm:ss",
  "snapshot_url": null,
  "branding": {
    "logo": null,
    "accent_color": "#2463EB",
    "email": {
      "footer": null,
      "logo_position": "left",
      "from": "noreply@signatureapi.com"
    }
  },
  "deliverable": {
    "id": "del_6FF89lKNyTNamOJCJd1tLL",
    "envelope_id": "eb4cf433-a8af-4161-b37b-7ef57d423e56",
    "name": null,
    "status": "pending",
    "type": "standard",
    "url": null,
    "password": null,
    "created_at": "2026-11-02T14:03:11.000Z",
    "generated_at": null,
    "timezone": "UTC",
    "language": "en",
    "timestamp_format": "MM/DD/YYYY HH:mm:ss",
    "included_documents": [
      "service_agreement"
    ]
  },
  "metadata": {
    "source": "zoho",
    "record_id": "4876876000000123001"
  },
  "sender": {
    "name": "Acme Corp Legal",
    "email": "legal@acme.example",
    "organization": "Acme Corp"
  },
  "captures": {},
  "documents": [
    {
      "id": "doc_HVl3Nj7XzTzX7jN3lVH5vn",
      "envelope_id": "eb4cf433-a8af-4161-b37b-7ef57d423e56",
      "key": "service_agreement",
      "title": null,
      "page_count": 1,
      "url": "https://pub-9cb75390636c4a8a83a6f76da33d7f45.r2.dev/docs-samples/service-agreement.pdf",
      "format": "pdf",
      "fixed_positions": [
        {
          "page": 1,
          "top": 172,
          "left": 210,
          "place_key": "signer_signature"
        }
      ],
      "places": [
        {
          "key": "signer_signature",
          "type": "signature",
          "recipient_key": "signer",
          "height": 60
        }
      ]
    }
  ],
  "recipients": [
    {
      "id": "re_49r1R2jpPDz8hSpP75ZkPp",
      "envelope_id": "eb4cf433-a8af-4161-b37b-7ef57d423e56",
      "type": "signer",
      "key": "signer",
      "email": "jane.doe@example.com",
      "name": "Jane Doe",
      "ceremony": {
        "authentication": [
          {
            "type": "email_link",
            "subject_override": null,
            "message_override": null
          }
        ],
        "embeddable_in": [],
        "redirect_url": null,
        "redirect_delay": 3,
        "url": null,
        "url_variant": "standard"
      },
      "ceremony_creation": "automatic",
      "delivery_type": "email",
      "signature_options": [
        "typed",
        "drawn"
      ],
      "status": "pending",
      "status_updated_at": "2026-11-02T14:03:11.000Z",
      "completed_at": null
    }
  ],
  "topics": [
    "no_code",
    "zoho"
  ],
  "created_at": "2026-11-02T14:03:11.000Z",
  "completed_at": null
}
```

Response 422 Unprocessable Content:

```json
{
  "type": "https://signatureapi.com/docs/v1/errors/validation-error",
  "title": "Validation Error",
  "status": 422,
  "errors": [
    "recipients[0].email must be a valid email address."
  ]
}
```

Errors that any request can return (authentication, rate limits, server errors) are on the [Errors](https://signatureapi.com/docs/api/errors) and [Authentication](https://signatureapi.com/docs/api/authentication) pages.
