OkaySend
What is an active Request?
An active Request is a Request that was sent and is currently in progress, accessible to the Client...
How to see responses for a Request?
Please log into the OkaySend Dashboard to find all active and archived Requests...
What is a Checklist?
Checklists and Requests are the same thing...
Version 1.0.0
Document Requests:
Signature Requests:
Document Requests:
This document shows you how to perform common operations, such as creating a new request and working with responses in Make.
OkaySend integrates with 5000+ apps through Make, offering nearly limitless possibilities for automation.
Triggers
Description:
Triggers when the status of a request changes to "complete" once all its required fields are filled and completed.
Sample Response:
{
"blocks": {
"-NfEL-9ppiMrh7rWurtd": {
"isRequired": true,
"status": "done",
"title": "Company Name",
"type": "type_short"
},
"-NfELB2HQ1R9NA4IyU4n": {
"isRequired": true,
"status": "done",
"title": "Sponsor Representative Full Name",
"type": "type_short"
},
"-NfELEYVQ8tO5Xx3P71V": {
"desc": "What's your role within the company? Feel free to explain or mention more than one title if what you do cannot be defined by a single category.
",
"isRequired": true,
"status": "done",
"title": "Position/Job Title",
"type": "type_long"
},
"-NfELUhU5As3_1L7tOyU": {
"isRequired": false,
"status": "done",
"title": "Business Address",
"type": "type_long"
},
"-NfELkVOWDvsXF-v9ggf": {
"desc": "Here, you can provide us with one or multiple contact numbers that we can reach you on if we need to discuss anything with you.
",
"isRequired": true,
"status": "done",
"title": "Business Contact Number(s)",
"type": "type_phone"
},
"-NfELrzftu9omDy8vLqR": {
"isRequired": true,
"status": "done",
"title": "Business Email Address",
"type": "type_short"
},
"-NfELurYdqSCOM6KVL9_": {
"isRequired": false,
"status": "done",
"title": "Company Website",
"type": "type_url"
},
"-NfELylOFCUEkAVBk9Ym": {
"desc": "Please ensure the graphics provided are clear and of high quality, they will be used on promotional materials.
",
"isRequired": false,
"status": "done",
"title": "Company Graphics",
"type": "type_upload",
"upload_rules": {
"allow_any": false,
"allowed_types": [
"drawing",
"image"
],
"max_files": "3",
"max_size": "5"
}
},
"-NfEM7dOdGhaQhpo0Mt6": {
"desc": "[THIS FIELD IS DESIGNED TO BE PRE-FILLED FOR THE CLIENT]
",
"isRequired": true,
"status": "done",
"title": "Host Organisation’s Name",
"type": "type_short"
},
"-NfEMGFX4zD3rG-arLso": {
"desc": "[THIS FIELD IS DESIGNED TO BE PRE-FILLED FOR THE CLIENT]
",
"isRequired": true,
"status": "done",
"title": "Event Name",
"type": "type_short"
},
"-NfEMMs1b76oQq8vnSmO": {
"desc": "[THIS FIELD IS DESIGNED TO BE PRE-FILLED FOR THE CLIENT]
",
"isRequired": true,
"status": "done",
"title": "Event Description",
"type": "type_short"
},
"-NfEMVfoZ9_r1RMb8crm": {
"desc": "[THIS FIELD IS DESIGNED TO BE PRE-FILLED FOR THE CLIENT]
",
"isRequired": true,
"status": "done",
"title": "Event Date",
"type": "type_short"
},
"-NfEMVxl6mZJJCpo39e9": {
"desc": "[THIS FIELD IS DESIGNED TO BE PRE-FILLED FOR THE CLIENT]
",
"isRequired": true,
"status": "done",
"title": "Event Location",
"type": "type_short"
},
"-NfEMfE5b4b74BwpStCR": {
"desc": "Here, we're looking for a number of [INSERT DESIRED CURRENCY HERE]
",
"isRequired": true,
"status": "done",
"title": "Sponsorship Value",
"type": "type_short"
},
"-NfEMlcTFyjPywpP6XAp": {
"desc": "[THIS FIELD IS DESIGNED TO BE PRE-FILLED FOR THE CLIENT, INFORMING THEM OF THE SPECIFIC ELEMENTS OF THE EVENT THAT THEIR MONEY WILL GO TOWARDS. EG: FIVE LARGE TABLES, SIXTEEN CHAIRS, ETC]
",
"isRequired": true,
"status": "done",
"title": "Sponsorship Description",
"type": "type_long"
},
"-NfEMs6V2QqKraVW_L8a": {
"isRequired": true,
"status": "done",
"title": "Have you previously sponsored any other events of ours in the past?",
"type": "type_short"
},
"-NfEMurFAPCkWSdGZuY8": {
"isRequired": true,
"status": "done",
"title": "What is your preferred payment method for sponsorship?",
"type": "type_short"
},
"-NfEMy3xz4IWi9am2Q7i": {
"desc": "Use this part to let us know of anything you'd like to mention. For example, this could be information that doesn't quite fit within the above categories, questions regarding this form and the next steps, etc.
",
"isRequired": true,
"status": "done",
"title": "Is there anything else we should know that you'd like to add?",
"type": "type_long"
}
},
"clients": {
"-N_pWd3qJCDqrO1Zzu_Apt": {
"company": "Let me search LLC",
"created_at": 1689893924614,
"email": "j.paul@gmail.com",
"id": "-N_pWd3qJCDqrO1Zzu_Apt",
"name": "John Paul",
"phone": "+11234567890",
"timestamp": -1689893923878
},
"-exampleJCDqrO1ZzuAPJCDW": {
"company": "Acme LLC",
"created_at": 1689893924614,
"email": "jane.smith@gmail.com",
"id": "-exampleJCDqrO1ZzuAPJCDW",
"name": "Jane Smith",
"phone": "",
"timestamp": -1689893923878
}
},
"multi_clients": true,
"login": false,
"client": {
"company": "Acme LLC",
"created_at": 1689893924614,
"email": "jane.smith@gmail.com",
"id": "-N_pWd3qJCDqrO1ZzuAPJCDW",
"name": "Jane Smith",
"phone": "",
"timestamp": -1689893923878
},
"client_id": "-N_pWd3qJCDqrO1ZzuAPJCDW",
"due_date": 1699210800000,
"entity": "example1aCN3qJCDWuAPWdbK23_Company",
"outline": [
{
"-NfEL-9o_tyyY23c1Yya": [
"-NfEL-9ppiMrh7rWurtd",
"-NfELB2HQ1R9NA4IyU4n",
"-NfELEYVQ8tO5Xx3P71V",
"-NfELUhU5As3_1L7tOyU",
"-NfELkVOWDvsXF-v9ggf",
"-NfELrzftu9omDy8vLqR",
"-NfELurYdqSCOM6KVL9_",
"-NfELylOFCUEkAVBk9Ym"
]
},
{
"-NfEM6cbnY0o1c-FUqz-": [
"-NfEM7dOdGhaQhpo0Mt6",
"-NfEMGFX4zD3rG-arLso",
"-NfEMMs1b76oQq8vnSmO",
"-NfEMVfoZ9_r1RMb8crm",
"-NfEMVxl6mZJJCpo39e9",
"-NfEMfE5b4b74BwpStCR",
"-NfEMlcTFyjPywpP6XAp",
"-NfEMs6V2QqKraVW_L8a",
"-NfEMurFAPCkWSdGZuY8",
"-NfEMy3xz4IWi9am2Q7i"
]
}
],
"progress": 100,
"reminder_sched": {
"due_date": 1699210800000,
"id": "default-d-1cUNj9cgy6i9",
"sched": [
null,
{
"date": "submit",
"days": "0",
"when": "after"
},
{
"date": "submit",
"days": "5",
"when": "after"
},
{
"date": "due",
"days": "5",
"when": "before"
},
{
"date": "due",
"days": "3",
"when": "before"
},
{
"date": "due",
"days": "0",
"when": "after"
},
{
"date": "due",
"days": "2",
"when": "after"
}
],
"sent_date": 1698640152432,
"title": "Default"
},
"response": {
"-NfEL-9ppiMrh7rWurtd": {
"value": "Acme LLC"
},
"-NfELB2HQ1R9NA4IyU4n": {
"value": "Jane Smith"
},
"-NfELEYVQ8tO5Xx3P71V": {
"value": "CEO"
},
"-NfELkVOWDvsXF-v9ggf": {
"value": "+12312322334"
},
"-NfELrzftu9omDy8vLqR": {
"value": "jane.smith@gmail.com"
},
"-NfELurYdqSCOM6KVL9_": {
"value": "https://example.com"
},
"-NfELylOFCUEkAVBk9Ym": {
"files": {
"-NiVN5DUtuj2CiugYJrl": {
"name": "WhatsApp Image 2023-10-30 at 15.57.34_bd6d9a23.jpg",
"size": 147359,
"type": "image/jpeg",
"url": "https://firebasestorage.googleapis.com/v0/b/farebin-af40f.appspot.com/o/files%2F1cUNLlSo8xaCNajIjG4WlpHgbK23_Company%2F-NiVN5DUtuj2CiugYJrl-WhatsApp%20Image%202023-10-30%20at%2015.57.34_bd6d9a23.jpg?alt=media&token=71973d8a-3f22-40f3-bacc-dbe08b5e9cdf"
},
"-NigN_AaVuVDvDFYRgZY": {
"name": "365782767_10161414285368028_1057165387620020197_n.jpg",
"size": 168714,
"type": "image/jpeg",
"url": "https://firebasestorage.googleapis.com/v0/b/farebin-af40f.appspot.com/o/files%2F1cUNLlSo8xaCNajIjG4WlpHgbK23_Company%2F-NigN_AaVuVDvDFYRgZY-365782767_10161414285368028_1057165387620020197_n.jpg?alt=media&token=d1bbc82d-720a-4274-bf6f-fd6e5fa96625"
}
}
},
"-NfEM7dOdGhaQhpo0Mt6": {
"value": "XYZ Tech Solutions"
},
"-NfEMGFX4zD3rG-arLso": {
"value": "TechFest 2023"
},
"-NfEMMs1b76oQq8vnSmO": {
"value": "A dynamic technology conference showcasing the latest innovations and trends."
},
"-NfEMVfoZ9_r1RMb8crm": {
"value": "12/5/2023"
},
"-NfEMVxl6mZJJCpo39e9": {
"value": "City Convention Center"
},
"-NfEMfE5b4b74BwpStCR": {
"value": "10,000"
},
"-NfEMlcTFyjPywpP6XAp": {
"value": "We are thrilled to support TechFest 2023 and contribute towards its success. Our sponsorship will specifically go towards enhancing the event experience. This includes providing cutting-edge tech displays and five large interactive booths ensuring a wonderful experience for all attendees."
},
"-NfEMs6V2QqKraVW_L8a": {
"value": "no"
},
"-NfEMurFAPCkWSdGZuY8": {
"value": "Bank transfer"
},
"-NfEMy3xz4IWi9am2Q7i": {
"value": ""
}
},
"sections": {
"-NfEL-9o_tyyY23c1Yya": {
"title": "Company Information"
},
"-NfEM6cbnY0o1c-FUqz-": {
"title": "Sponsorship information"
}
},
"sent_date": 1698640152432,
"status": "complete",
"title": "Sponsor Info",
"request_id": "example_id_123"
}
Response Payload:
| Property Name | Type | Description |
|---|---|---|
| blocks | collection | A JSON object containing information about different blocks. |
| multi_clients | boolean | Will be set to true if the request was sent to multiple clients. |
| login | boolean | Will be set to true if the request requires email verification from all clients for access. |
| clients | collection | Details about all the clients, including company name, email, and other information. |
| client | collection | Details about the client, including company name, email, and other information. |
| client_id | text | The unique identifier for the client. |
| due_date | number | The due date for the request. A timestamp. |
| entity | text | The unique identifier of your OkaySend account otherwise referred to as Account ID or Company ID. |
| outline | Array | A list of Objects containing the section IDs and the block IDs. |
| progress | number | The progress of the checklist. A percentage-based progress indicator, where 0 represents no progress, and 100 represents completion or full progress. |
| reminder_sched | collection | Details about the rules that OkaySend follows to send reminders. |
| response | collection | Details about the responses collected from the client. Includes the block ID (ID for the question) and the value (input from the client) properties. |
| sections | collection | A JSON object of the sections that group the blocks. Includes the section ID and the title (name of the section) properties. |
| sent_date | number | The timestamp of the request when it was first finalized and sent. |
| status | text | The current status of the request. See What do the Request statuses mean? |
| title | text | The name of the request. |
| request_id | text | The unique identifier of the request. |
Description:
Triggers when a new client is added (created) in OkaySend.
Sample Response:
{
"name": "John Doe",
"email": "example@email.com",
"phone": "",
"company": "Acme Corporation",
"created_at": 1690300434633,
"id": "-NlybKR3qJYCzp_x7y-3",
"account_id": "example1aCN3qJCDWuAPWdbK23_Company"
}
Response Payload:
| Property Name | Type | Description |
|---|---|---|
| name | text | The name of the client (e.g., "John Doe"). |
| text | The email address associated with the client (e.g., "example@email.com"). | |
| phone | text | The phone number associated with the client. Returns empty string, if no phone number was provided. |
| company | text | The name of the company or organization (e.g., "Acme Corporation"). Returns empty string, if no company name was provided. |
| created_at | number | The timestamp indicating the date and time when the record was created (e.g., 1690300434633). |
| id | text | A unique identifier for the client added (e.g., "-NlybKR3qJYCzp_x7y-3"). |
| account_id | text | The unique identifier of your OkaySend account (e.g., "example1aCN3qJCDWuAPWdbK23_Company"). |
Description:
Triggers when an existing client is updated in OkaySend.
Sample Response:
{
"name": "John Doe",
"email": "example@email.com",
"phone": "",
"company": "Acme Corporation",
"created_at": 1690300434633,
"id": "-NlybKR3qJYCzp_x7y-3",
"account_id": "example1aCN3qJCDWuAPWdbK23_Company"
}
Response Payload:
| Property Name | Type | Description |
|---|---|---|
| name | text | The name of the client (e.g., "John Doe"). |
| text | The email address associated with the client (e.g., "example@email.com"). | |
| phone | text | The phone number associated with the client. Returns empty string, if no phone number was provided. |
| company | text | The name of the company or organization (e.g., "Acme Corporation"). Returns empty string, if no company name was provided. |
| id | text | A unique identifier for the client updated (e.g., "-NlybKR3qJYCzp_x7y-3"). |
| account_id | text | The unique identifier of your OkaySend account (e.g., "example1aCN3qJCDWuAPWdbK23_Company"). |
Description:
Triggers when a field is filled, completed, and marked "done" in OkaySend.
Sample Response:
{
"title": "Please upload your company graphics",
"desc": "Please ensure the graphics provided are clear and of high quality, they will be used on promotional materials.
",
"type": "type_upload",
"value": "https://firebasestorage.googleapis.com/v0/b/farebin-af40f.appspot.com/o/attachment-zapier-test.png?alt=media&token=a94e766a-a010-4934-9228-9870c4ae463e,https://firebasestorage.googleapis.com/v0/b/farebin-af40f.appspot.com/o/upload-zapier-test.JPG?alt=media&token=a04a5fca-710f-4785-852c-72f5aefbd763",
"status": "done",
"is_required": false,
"id": "-Nly4iRLY4YCzp_y7y-3",
"section_title": "Section 1",
"section_id": "example_section_id_123",
"request_title": "Example Checklist",
"request_id": "example_id_123",
"account_id": "example1aCN3qJCDWuAPWdbK23_Company"
}
Response Payload:
| Property Name | Type | Description |
|---|---|---|
| title | text | The title of the field or the question (e.g., "Please upload your company graphics"). |
| desc | text | The description of the field or question. It may contain HTML content (e.g., "Please ensure the graphics provided are clear and of high quality, they will be used on promotional materials."). |
| type | text | The type of the request (e.g., "type_upload"). See: How many types of fields/questions can be added? |
| value | text | The URLs of the uploaded graphics. (e.g., In this sample response, it is a comma-separated string of image URLs "https://.../attachment-zapier-test.png,https://.../upload-zapier-test.JPG"). |
| status | text | The status of the field or question (e.g., "done"). |
| is_required | boolean | Indicates whether the response for the field is required (e.g., false). |
| id | text | A unique identifier for the field (e.g., "-Nly4iRLY4YCzp_y7y-3"). |
| section_title | text | The title of the section to which the field belongs (e.g., "Section 1"). |
| section_id | text | The unique identifier for the section to which the field belongs (e.g., "example_section_id_123"). |
| request_title | text | The title of the request to which the field belongs (e.g., "Example Checklist"). |
| request_id | text | The unique identifier for the request to which the field belongs (e.g., "example_id_123"). |
| account_id | text | The unique identifier of with the OkaySend account (e.g., "example1aCN3qJCDWuAPWdbK23_Company"). |
A field may trigger the "Watch Field Completion" trigger more than once in the case where the client edits their response.
Will not trigger for existing requests. May only work for requests created after the trigger is set up and live.
Use the Make's built-in Filter tool to check the type of the field. Field types that can have more than 1 value (and have collected more than 1 value) will always be returned as a comma-separated string. (e.g. "type_upload", "type_multi", and "type_checkbox")
Description:
Triggers when a response to a field is approved in OkaySend or, in other words, when the status of the field changes to "approved".
Sample Response:
{
"title": "Please upload your company graphics",
"desc": "Please ensure the graphics provided are clear and of high quality, they will be used on promotional materials.
",
"type": "type_upload",
"value": "https://firebasestorage.googleapis.com/v0/b/farebin-af40f.appspot.com/o/attachment-zapier-test.png?alt=media&token=a94e766a-a010-4934-9228-9870c4ae463e,https://firebasestorage.googleapis.com/v0/b/farebin-af40f.appspot.com/o/upload-zapier-test.JPG?alt=media&token=a04a5fca-710f-4785-852c-72f5aefbd763",
"status": "approved",
"is_required": false,
"id": "-Nly4iRLY4YCzp_y7y-3",
"section_title": "Section 1",
"section_id": "example_section_id_123",
"request_title": "Example Checklist",
"request_id": "example_id_123",
"account_id": "example1aCN3qJCDWuAPWdbK23_Company",
"client": {
"name": "Jon Snow",
"email": "example@email.com",
"phone": "",
"company": "King in the North",
"id": "-Nly4iRLY4YCzp_y7y-3"
}
}
Response Payload:
| Property Name | Type | Description |
|---|---|---|
| title | text | The title of the field or the question (e.g., "Please upload your company graphics"). |
| desc | text | The description of the field or question. It may contain HTML content (e.g., "Please ensure the graphics provided are clear and of high quality, they will be used on promotional materials."). |
| type | text | The type of the request (e.g., "type_upload"). See: How many types of fields/questions can be added? |
| value | text | The URLs of the uploaded graphics. (e.g., In this sample response, it is a comma-separated string of image URLs "https://.../attachment-zapier-test.png,https://.../upload-zapier-test.JPG"). |
| status | text | The status of the field or question (e.g., "approved"). |
| is_required | boolean | Indicates whether the response for the field is required (e.g., false). |
| id | text | A unique identifier for the field (e.g., "-Nly4iRLY4YCzp_y7y-3"). |
| section_title | text | The title of the section to which the field belongs (e.g., "Section 1"). |
| section_id | text | The unique identifier for the section to which the field belongs (e.g., "example_section_id_123"). |
| request_title | text | The title of the request to which the field belongs (e.g., "Example Checklist"). |
| request_id | text | The unique identifier for the request to which the field belongs (e.g., "example_id_123"). |
| account_id | text | The unique identifier of with the OkaySend account (e.g., "example1aCN3qJCDWuAPWdbK23_Company"). |
Use the Make's built-in Filter tool to check the type of the field. Field types that can have more than 1 value (and have collected more than 1 value) will always be returned as a comma-separated string. (e.g. "type_upload", "type_multi", and "type_checkbox")
Description:
Triggers when a response to a field is rejected in OkaySend or, in other words, when the status of the field changes to "rejected".
Sample Response:
{
"title": "Please upload your company graphics",
"desc": "Please ensure the graphics provided are clear and of high quality, they will be used on promotional materials.
",
"type": "type_upload",
"value": "https://firebasestorage.googleapis.com/v0/b/farebin-af40f.appspot.com/o/attachment-zapier-test.png?alt=media&token=a94e766a-a010-4934-9228-9870c4ae463e,https://firebasestorage.googleapis.com/v0/b/farebin-af40f.appspot.com/o/upload-zapier-test.JPG?alt=media&token=a04a5fca-710f-4785-852c-72f5aefbd763",
"status": "rejected",
"is_required": false,
"id": "-Nly4iRLY4YCzp_y7y-3",
"section_title": "Section 1",
"section_id": "example_section_id_123",
"request_title": "Example Checklist",
"request_id": "example_id_123",
"account_id": "example1aCN3qJCDWuAPWdbK23_Company",
"client": {
"name": "Jon Snow",
"email": "example@email.com",
"phone": "",
"company": "King in the North",
"id": "-Nly4iRLY4YCzp_y7y-3"
}
}
Response Payload:
| Property Name | Type | Description |
|---|---|---|
| title | text | The title of the field or the question (e.g., "Please upload your company graphics"). |
| desc | text | The description of the field or question. It may contain HTML content (e.g., "Please ensure the graphics provided are clear and of high quality, they will be used on promotional materials."). |
| type | text | The type of the request (e.g., "type_upload"). See: How many types of fields/questions can be added? |
| value | text | The URLs of the uploaded graphics. (e.g., In this sample response, it is a comma-separated string of image URLs "https://.../attachment-zapier-test.png,https://.../upload-zapier-test.JPG"). |
| status | text | The status of the field or question (e.g., "rejected"). |
| is_required | boolean | Indicates whether the response for the field is required (e.g., false). |
| id | text | A unique identifier for the field (e.g., "-Nly4iRLY4YCzp_y7y-3"). |
| section_title | text | The title of the section to which the field belongs (e.g., "Section 1"). |
| section_id | text | The unique identifier for the section to which the field belongs (e.g., "example_section_id_123"). |
| request_title | text | The title of the request to which the field belongs (e.g., "Example Checklist"). |
| request_id | text | The unique identifier for the request to which the field belongs (e.g., "example_id_123"). |
| account_id | text | The unique identifier of with the OkaySend account (e.g., "example1aCN3qJCDWuAPWdbK23_Company"). |
Use the Make's built-in Filter tool to check the type of the field. Field types that can have more than 1 value (and have collected more than 1 value) will always be returned as a comma-separated string. (e.g. "type_upload", "type_multi", and "type_checkbox")
Description:
Triggers when a request is marked "done" and archived.
Sample Response:
{
"blocks": {
"-NfEL-9ppiMrh7rWurtd": {
"isRequired": true,
"status": "done",
"title": "Company Name",
"type": "type_short"
},
"-NfELB2HQ1R9NA4IyU4n": {
"isRequired": true,
"status": "done",
"title": "Sponsor Representative Full Name",
"type": "type_short"
},
"-NfELEYVQ8tO5Xx3P71V": {
"desc": "What's your role within the company? Feel free to explain or mention more than one title if what you do cannot be defined by a single category.
",
"isRequired": true,
"status": "done",
"title": "Position/Job Title",
"type": "type_long"
},
"-NfELUhU5As3_1L7tOyU": {
"isRequired": false,
"status": "done",
"title": "Business Address",
"type": "type_long"
},
"-NfELkVOWDvsXF-v9ggf": {
"desc": "Here, you can provide us with one or multiple contact numbers that we can reach you on if we need to discuss anything with you.
",
"isRequired": true,
"status": "done",
"title": "Business Contact Number(s)",
"type": "type_phone"
},
"-NfELrzftu9omDy8vLqR": {
"isRequired": true,
"status": "done",
"title": "Business Email Address",
"type": "type_short"
},
"-NfELurYdqSCOM6KVL9_": {
"isRequired": false,
"status": "done",
"title": "Company Website",
"type": "type_url"
},
"-NfELylOFCUEkAVBk9Ym": {
"desc": "Please ensure the graphics provided are clear and of high quality, they will be used on promotional materials.
",
"isRequired": false,
"status": "done",
"title": "Company Graphics",
"type": "type_upload",
"upload_rules": {
"allow_any": false,
"allowed_types": [
"drawing",
"image"
],
"max_files": "3",
"max_size": "5"
}
},
"-NfEM7dOdGhaQhpo0Mt6": {
"desc": "[THIS FIELD IS DESIGNED TO BE PRE-FILLED FOR THE CLIENT]
",
"isRequired": true,
"status": "done",
"title": "Host Organisation’s Name",
"type": "type_short"
},
"-NfEMGFX4zD3rG-arLso": {
"desc": "[THIS FIELD IS DESIGNED TO BE PRE-FILLED FOR THE CLIENT]
",
"isRequired": true,
"status": "done",
"title": "Event Name",
"type": "type_short"
},
"-NfEMMs1b76oQq8vnSmO": {
"desc": "[THIS FIELD IS DESIGNED TO BE PRE-FILLED FOR THE CLIENT]
",
"isRequired": true,
"status": "done",
"title": "Event Description",
"type": "type_short"
},
"-NfEMVfoZ9_r1RMb8crm": {
"desc": "[THIS FIELD IS DESIGNED TO BE PRE-FILLED FOR THE CLIENT]
",
"isRequired": true,
"status": "done",
"title": "Event Date",
"type": "type_short"
},
"-NfEMVxl6mZJJCpo39e9": {
"desc": "[THIS FIELD IS DESIGNED TO BE PRE-FILLED FOR THE CLIENT]
",
"isRequired": true,
"status": "done",
"title": "Event Location",
"type": "type_short"
},
"-NfEMfE5b4b74BwpStCR": {
"desc": "Here, we're looking for a number of [INSERT DESIRED CURRENCY HERE]
",
"isRequired": true,
"status": "done",
"title": "Sponsorship Value",
"type": "type_short"
},
"-NfEMlcTFyjPywpP6XAp": {
"desc": "[THIS FIELD IS DESIGNED TO BE PRE-FILLED FOR THE CLIENT, INFORMING THEM OF THE SPECIFIC ELEMENTS OF THE EVENT THAT THEIR MONEY WILL GO TOWARDS. EG: FIVE LARGE TABLES, SIXTEEN CHAIRS, ETC]
",
"isRequired": true,
"status": "done",
"title": "Sponsorship Description",
"type": "type_long"
},
"-NfEMs6V2QqKraVW_L8a": {
"isRequired": true,
"status": "done",
"title": "Have you previously sponsored any other events of ours in the past?",
"type": "type_short"
},
"-NfEMurFAPCkWSdGZuY8": {
"isRequired": true,
"status": "done",
"title": "What is your preferred payment method for sponsorship?",
"type": "type_short"
},
"-NfEMy3xz4IWi9am2Q7i": {
"desc": "Use this part to let us know of anything you'd like to mention. For example, this could be information that doesn't quite fit within the above categories, questions regarding this form and the next steps, etc.
",
"isRequired": true,
"status": "done",
"title": "Is there anything else we should know that you'd like to add?",
"type": "type_long"
}
},
"clients": {
"-N_pWd3qJCDqrO1Zzu_Apt": {
"company": "Let me search LLC",
"created_at": 1689893924614,
"email": "j.paul@gmail.com",
"id": "-N_pWd3qJCDqrO1Zzu_Apt",
"name": "John Paul",
"phone": "+11234567890",
"timestamp": -1689893923878
},
"-exampleJCDqrO1ZzuAPJCDW": {
"company": "Acme LLC",
"created_at": 1689893924614,
"email": "jane.smith@gmail.com",
"id": "-exampleJCDqrO1ZzuAPJCDW",
"name": "Jane Smith",
"phone": "",
"timestamp": -1689893923878
}
},
"multi_clients": true,
"login": false,
"client": {
"company": "Acme LLC",
"created_at": 1689893924614,
"email": "jane.smith@gmail.com",
"id": "-exampleJCDqrO1ZzuAPJCDW",
"name": "Jane Smith",
"phone": "",
"timestamp": -1689893923878
},
"client_id": "-exampleJCDqrO1ZzuAPJCDW",
"due_date": 1699210800000,
"entity": "example1aCN3qJCDWuAPWdbK23_Company",
"outline": [
{
"-NfEL-9o_tyyY23c1Yya": [
"-NfEL-9ppiMrh7rWurtd",
"-NfELB2HQ1R9NA4IyU4n",
"-NfELEYVQ8tO5Xx3P71V",
"-NfELUhU5As3_1L7tOyU",
"-NfELkVOWDvsXF-v9ggf",
"-NfELrzftu9omDy8vLqR",
"-NfELurYdqSCOM6KVL9_",
"-NfELylOFCUEkAVBk9Ym"
]
},
{
"-NfEM6cbnY0o1c-FUqz-": [
"-NfEM7dOdGhaQhpo0Mt6",
"-NfEMGFX4zD3rG-arLso",
"-NfEMMs1b76oQq8vnSmO",
"-NfEMVfoZ9_r1RMb8crm",
"-NfEMVxl6mZJJCpo39e9",
"-NfEMfE5b4b74BwpStCR",
"-NfEMlcTFyjPywpP6XAp",
"-NfEMs6V2QqKraVW_L8a",
"-NfEMurFAPCkWSdGZuY8",
"-NfEMy3xz4IWi9am2Q7i"
]
}
],
"progress": 100,
"reminder_sched": {
"due_date": 1699210800000,
"id": "default-d-1cUNj9cgy6i9",
"sched": [
null,
{
"date": "submit",
"days": "0",
"when": "after"
},
{
"date": "submit",
"days": "5",
"when": "after"
},
{
"date": "due",
"days": "5",
"when": "before"
},
{
"date": "due",
"days": "3",
"when": "before"
},
{
"date": "due",
"days": "0",
"when": "after"
},
{
"date": "due",
"days": "2",
"when": "after"
}
],
"sent_date": 1698640152432,
"title": "Default"
},
"response": {
"-NfEL-9ppiMrh7rWurtd": {
"value": "Acme LLC"
},
"-NfELB2HQ1R9NA4IyU4n": {
"value": "Jane Smith"
},
"-NfELEYVQ8tO5Xx3P71V": {
"value": "CEO"
},
"-NfELkVOWDvsXF-v9ggf": {
"value": "+12312322334"
},
"-NfELrzftu9omDy8vLqR": {
"value": "jane.smith@gmail.com"
},
"-NfELurYdqSCOM6KVL9_": {
"value": "https://example.com"
},
"-NfELylOFCUEkAVBk9Ym": {
"files": {
"-NiVN5DUtuj2CiugYJrl": {
"name": "WhatsApp Image 2023-10-30 at 15.57.34_bd6d9a23.jpg",
"size": 147359,
"type": "image/jpeg",
"url": "https://firebasestorage.googleapis.com/v0/b/farebin-af40f.appspot.com/o/files%2F1cUNLlSo8xaCNajIjG4WlpHgbK23_Company%2F-NiVN5DUtuj2CiugYJrl-WhatsApp%20Image%202023-10-30%20at%2015.57.34_bd6d9a23.jpg?alt=media&token=71973d8a-3f22-40f3-bacc-dbe08b5e9cdf"
},
"-NigN_AaVuVDvDFYRgZY": {
"name": "365782767_10161414285368028_1057165387620020197_n.jpg",
"size": 168714,
"type": "image/jpeg",
"url": "https://firebasestorage.googleapis.com/v0/b/farebin-af40f.appspot.com/o/files%2F1cUNLlSo8xaCNajIjG4WlpHgbK23_Company%2F-NigN_AaVuVDvDFYRgZY-365782767_10161414285368028_1057165387620020197_n.jpg?alt=media&token=d1bbc82d-720a-4274-bf6f-fd6e5fa96625"
}
}
},
"-NfEM7dOdGhaQhpo0Mt6": {
"value": "XYZ Tech Solutions"
},
"-NfEMGFX4zD3rG-arLso": {
"value": "TechFest 2023"
},
"-NfEMMs1b76oQq8vnSmO": {
"value": "A dynamic technology conference showcasing the latest innovations and trends."
},
"-NfEMVfoZ9_r1RMb8crm": {
"value": "12/5/2023"
},
"-NfEMVxl6mZJJCpo39e9": {
"value": "City Convention Center"
},
"-NfEMfE5b4b74BwpStCR": {
"value": "10,000"
},
"-NfEMlcTFyjPywpP6XAp": {
"value": "We are thrilled to support TechFest 2023 and contribute towards its success. Our sponsorship will specifically go towards enhancing the event experience. This includes providing cutting-edge tech displays and five large interactive booths ensuring a wonderful experience for all attendees."
},
"-NfEMs6V2QqKraVW_L8a": {
"value": "no"
},
"-NfEMurFAPCkWSdGZuY8": {
"value": "Bank transfer"
},
"-NfEMy3xz4IWi9am2Q7i": {
"value": ""
}
},
"sections": {
"-NfEL-9o_tyyY23c1Yya": {
"title": "Company Information"
},
"-NfEM6cbnY0o1c-FUqz-": {
"title": "Sponsorship information"
}
},
"sent_date": 1698640152432,
"status": "archived",
"title": "Example Checklist Sponsor Info",
"request_id": "example_id_123"
}
Response Payload:
| Property Name | Type | Description |
|---|---|---|
| blocks | collection | A JSON object containing information about different blocks. |
| multi_clients | boolean | Will be set to true if the request was sent to multiple clients. |
| login | boolean | Will be set to true if the request requires email verification from all clients for access. |
| clients | collection | Details about all the clients, including company name, email, and other information. |
| client | collection | Details about the client, including company name, email, and other information. |
| client_id | text | The unique identifier for the client. |
| due_date | number | The due date for the request. A timestamp. |
| entity | text | The unique identifier of your OkaySend account otherwise referred to as Account ID or Company ID. |
| outline | Array | A list of Objects containing the section IDs and the block IDs. |
| progress | number | The progress of the checklist. A percentage-based progress indicator, where 0 represents no progress, and 100 represents completion or full progress. |
| reminder_sched | collection | Details about the rules that OkaySend follows to send reminders. |
| response | collection | Details about the responses collected from the client. Includes the block ID (ID for the question) and the value (input from the client) properties. |
| sections | collection | A JSON object of the sections that group the blocks. Includes the section ID and the title (name of the section) properties. |
| sent_date | number | The timestamp of the request when it was first finalized and sent. |
| status | text | The current status of the request. See What do the Request statuses mean? |
| title | text | The name of the request. |
| request_id | text | The unique identifier of the request. |
Description:
Triggers when a request is first moved from "Drafts" to "Sent".
Sample Response:
{
"blocks": {
"-NfEL-9ppiMrh7rWurtd": {
"isRequired": true,
"status": "done",
"title": "Company Name",
"type": "type_short"
},
"-NfELB2HQ1R9NA4IyU4n": {
"isRequired": true,
"status": "done",
"title": "Sponsor Representative Full Name",
"type": "type_short"
},
"-NfELEYVQ8tO5Xx3P71V": {
"desc": "What's your role within the company? Feel free to explain or mention more than one title if what you do cannot be defined by a single category.
",
"isRequired": true,
"status": "done",
"title": "Position/Job Title",
"type": "type_long"
},
"-NfELUhU5As3_1L7tOyU": {
"isRequired": false,
"status": "done",
"title": "Business Address",
"type": "type_long"
},
"-NfELkVOWDvsXF-v9ggf": {
"desc": "Here, you can provide us with one or multiple contact numbers that we can reach you on if we need to discuss anything with you.
",
"isRequired": true,
"status": "done",
"title": "Business Contact Number(s)",
"type": "type_phone"
},
"-NfELrzftu9omDy8vLqR": {
"isRequired": true,
"status": "done",
"title": "Business Email Address",
"type": "type_short"
},
"-NfELurYdqSCOM6KVL9_": {
"isRequired": false,
"status": "done",
"title": "Company Website",
"type": "type_url"
},
"-NfELylOFCUEkAVBk9Ym": {
"desc": "Please ensure the graphics provided are clear and of high quality, they will be used on promotional materials.
",
"isRequired": false,
"status": "done",
"title": "Company Graphics",
"type": "type_upload",
"upload_rules": {
"allow_any": false,
"allowed_types": [
"drawing",
"image"
],
"max_files": "3",
"max_size": "5"
}
},
"-NfEM7dOdGhaQhpo0Mt6": {
"desc": "[THIS FIELD IS DESIGNED TO BE PRE-FILLED FOR THE CLIENT]
",
"isRequired": true,
"status": "done",
"title": "Host Organisation’s Name",
"type": "type_short"
},
"-NfEMGFX4zD3rG-arLso": {
"desc": "[THIS FIELD IS DESIGNED TO BE PRE-FILLED FOR THE CLIENT]
",
"isRequired": true,
"status": "done",
"title": "Event Name",
"type": "type_short"
},
"-NfEMMs1b76oQq8vnSmO": {
"desc": "[THIS FIELD IS DESIGNED TO BE PRE-FILLED FOR THE CLIENT]
",
"isRequired": true,
"status": "done",
"title": "Event Description",
"type": "type_short"
},
"-NfEMVfoZ9_r1RMb8crm": {
"desc": "[THIS FIELD IS DESIGNED TO BE PRE-FILLED FOR THE CLIENT]
",
"isRequired": true,
"status": "done",
"title": "Event Date",
"type": "type_short"
},
"-NfEMVxl6mZJJCpo39e9": {
"desc": "[THIS FIELD IS DESIGNED TO BE PRE-FILLED FOR THE CLIENT]
",
"isRequired": true,
"status": "done",
"title": "Event Location",
"type": "type_short"
},
"-NfEMfE5b4b74BwpStCR": {
"desc": "Here, we're looking for a number of [INSERT DESIRED CURRENCY HERE]
",
"isRequired": true,
"status": "done",
"title": "Sponsorship Value",
"type": "type_short"
},
"-NfEMlcTFyjPywpP6XAp": {
"desc": "[THIS FIELD IS DESIGNED TO BE PRE-FILLED FOR THE CLIENT, INFORMING THEM OF THE SPECIFIC ELEMENTS OF THE EVENT THAT THEIR MONEY WILL GO TOWARDS. EG: FIVE LARGE TABLES, SIXTEEN CHAIRS, ETC]
",
"isRequired": true,
"status": "done",
"title": "Sponsorship Description",
"type": "type_long"
},
"-NfEMs6V2QqKraVW_L8a": {
"isRequired": true,
"status": "done",
"title": "Have you previously sponsored any other events of ours in the past?",
"type": "type_short"
},
"-NfEMurFAPCkWSdGZuY8": {
"isRequired": true,
"status": "done",
"title": "What is your preferred payment method for sponsorship?",
"type": "type_short"
},
"-NfEMy3xz4IWi9am2Q7i": {
"desc": "Use this part to let us know of anything you'd like to mention. For example, this could be information that doesn't quite fit within the above categories, questions regarding this form and the next steps, etc.
",
"isRequired": true,
"status": "done",
"title": "Is there anything else we should know that you'd like to add?",
"type": "type_long"
}
},
"clients": {
"-N_pWd3qJCDqrO1Zzu_Apt": {
"company": "Let me search LLC",
"created_at": 1689893924614,
"email": "j.paul@gmail.com",
"id": "-N_pWd3qJCDqrO1Zzu_Apt",
"name": "John Paul",
"phone": "+11234567890",
"timestamp": -1689893923878
},
"-exampleJCDqrO1ZzuAPJCDW": {
"company": "Acme LLC",
"created_at": 1689893924614,
"email": "jane.smith@gmail.com",
"id": "-exampleJCDqrO1ZzuAPJCDW",
"name": "Jane Smith",
"phone": "",
"timestamp": -1689893923878
}
},
"multi_clients": true,
"login": false,
"client": {
"company": "Acme LLC",
"created_at": 1689893924614,
"email": "jane.smith@gmail.com",
"id": "-exampleJCDqrO1ZzuAPJCDW",
"name": "Jane Smith",
"phone": "",
"timestamp": -1689893923878
},
"client_id": "-exampleJCDqrO1ZzuAPJCDW",
"due_date": 1699210800000,
"entity": "example1aCN3qJCDWuAPWdbK23_Company",
"outline": [
{
"-NfEL-9o_tyyY23c1Yya": [
"-NfEL-9ppiMrh7rWurtd",
"-NfELB2HQ1R9NA4IyU4n",
"-NfELEYVQ8tO5Xx3P71V",
"-NfELUhU5As3_1L7tOyU",
"-NfELkVOWDvsXF-v9ggf",
"-NfELrzftu9omDy8vLqR",
"-NfELurYdqSCOM6KVL9_",
"-NfELylOFCUEkAVBk9Ym"
]
},
{
"-NfEM6cbnY0o1c-FUqz-": [
"-NfEM7dOdGhaQhpo0Mt6",
"-NfEMGFX4zD3rG-arLso",
"-NfEMMs1b76oQq8vnSmO",
"-NfEMVfoZ9_r1RMb8crm",
"-NfEMVxl6mZJJCpo39e9",
"-NfEMfE5b4b74BwpStCR",
"-NfEMlcTFyjPywpP6XAp",
"-NfEMs6V2QqKraVW_L8a",
"-NfEMurFAPCkWSdGZuY8",
"-NfEMy3xz4IWi9am2Q7i"
]
}
],
"progress": 100,
"reminder_sched": {
"due_date": 1699210800000,
"id": "default-d-1cUNj9cgy6i9",
"sched": [
null,
{
"date": "submit",
"days": "0",
"when": "after"
},
{
"date": "submit",
"days": "5",
"when": "after"
},
{
"date": "due",
"days": "5",
"when": "before"
},
{
"date": "due",
"days": "3",
"when": "before"
},
{
"date": "due",
"days": "0",
"when": "after"
},
{
"date": "due",
"days": "2",
"when": "after"
}
],
"sent_date": 1698640152432,
"title": "Default"
},
"response": {
"-NfEL-9ppiMrh7rWurtd": {
"value": "Acme LLC"
},
"-NfELB2HQ1R9NA4IyU4n": {
"value": "Jane Smith"
},
"-NfELEYVQ8tO5Xx3P71V": {
"value": "CEO"
},
"-NfELkVOWDvsXF-v9ggf": {
"value": "+12312322334"
},
"-NfELrzftu9omDy8vLqR": {
"value": "jane.smith@gmail.com"
},
"-NfELurYdqSCOM6KVL9_": {
"value": "https://example.com"
},
"-NfELylOFCUEkAVBk9Ym": {
"files": {
"-NiVN5DUtuj2CiugYJrl": {
"name": "WhatsApp Image 2023-10-30 at 15.57.34_bd6d9a23.jpg",
"size": 147359,
"type": "image/jpeg",
"url": "https://firebasestorage.googleapis.com/v0/b/farebin-af40f.appspot.com/o/files%2F1cUNLlSo8xaCNajIjG4WlpHgbK23_Company%2F-NiVN5DUtuj2CiugYJrl-WhatsApp%20Image%202023-10-30%20at%2015.57.34_bd6d9a23.jpg?alt=media&token=71973d8a-3f22-40f3-bacc-dbe08b5e9cdf"
},
"-NigN_AaVuVDvDFYRgZY": {
"name": "365782767_10161414285368028_1057165387620020197_n.jpg",
"size": 168714,
"type": "image/jpeg",
"url": "https://firebasestorage.googleapis.com/v0/b/farebin-af40f.appspot.com/o/files%2F1cUNLlSo8xaCNajIjG4WlpHgbK23_Company%2F-NigN_AaVuVDvDFYRgZY-365782767_10161414285368028_1057165387620020197_n.jpg?alt=media&token=d1bbc82d-720a-4274-bf6f-fd6e5fa96625"
}
}
},
"-NfEM7dOdGhaQhpo0Mt6": {
"value": "XYZ Tech Solutions"
},
"-NfEMGFX4zD3rG-arLso": {
"value": "TechFest 2023"
},
"-NfEMMs1b76oQq8vnSmO": {
"value": "A dynamic technology conference showcasing the latest innovations and trends."
},
"-NfEMVfoZ9_r1RMb8crm": {
"value": "12/5/2023"
},
"-NfEMVxl6mZJJCpo39e9": {
"value": "City Convention Center"
},
"-NfEMfE5b4b74BwpStCR": {
"value": "10,000"
},
"-NfEMlcTFyjPywpP6XAp": {
"value": "We are thrilled to support TechFest 2023 and contribute towards its success. Our sponsorship will specifically go towards enhancing the event experience. This includes providing cutting-edge tech displays and five large interactive booths ensuring a wonderful experience for all attendees."
},
"-NfEMs6V2QqKraVW_L8a": {
"value": "no"
},
"-NfEMurFAPCkWSdGZuY8": {
"value": "Bank transfer"
},
"-NfEMy3xz4IWi9am2Q7i": {
"value": ""
}
},
"sections": {
"-NfEL-9o_tyyY23c1Yya": {
"title": "Company Information"
},
"-NfEM6cbnY0o1c-FUqz-": {
"title": "Sponsorship information"
}
},
"sent_date": 1698640152432,
"status": "sent",
"title": "Example Checklist Sponsor Info",
"request_id": "example_id_123"
}
Response Payload:
| Property Name | Type | Description |
|---|---|---|
| blocks | collection | A JSON object containing information about different blocks. |
| multi_clients | boolean | Will be set to true if the request was sent to multiple clients. |
| login | boolean | Will be set to true if the request requires email verification from all clients for access. |
| clients | collection | Details about all the clients, including company name, email, and other information. |
| client | collection | Details about the client, including company name, email, and other information. |
| client_id | text | The unique identifier for the client. |
| due_date | number | The due date for the request. A timestamp. |
| entity | text | The unique identifier of your OkaySend account otherwise referred to as Account ID or Company ID. |
| outline | Array | A list of Objects containing the section IDs and the block IDs. |
| progress | number | The progress of the checklist. A percentage-based progress indicator, where 0 represents no progress, and 100 represents completion or full progress. |
| reminder_sched | collection | Details about the rules that OkaySend follows to send reminders. |
| response | collection | Details about the responses collected from the client. Includes the block ID (ID for the question) and the value (input from the client) properties. |
| sections | collection | A JSON object of the sections that group the blocks. Includes the section ID and the title (name of the section) properties. |
| sent_date | number | The timestamp of the request when it was first finalized and sent. |
| status | text | The current status of the request. See What do the Request statuses mean? |
| title | text | The name of the request. |
| request_id | text | The unique identifier of the request. |
Description:
Triggers when a signature request is declined by a signer.
Sample Response:
{
"documents": {
"files": {
"-OW9Al1ACsr3el2ZyHEV": {
"companyID": "123example_Company",
"h": 640,
"name": "imageglmge094tiowgtehi9wrgeyniothdhhd.jpg",
"pdf": "https://firebasestorage.googleapis.com/v0/b/farebin-af40f.appspot.com/o/files%2F1cUNHgbK23_Company/-O7bx0gZ0e_7AZmzx0t0-8ef4e9e136f810332300be59ea80757bd.pdf?alt=media",
"size": 25669,
"thumbnail": "https://firebasestorage.googleapis.com/v0/b/farebin-af40f.appspot.com/o/files/1cUNHgbK23_Company/-OW8eEDU0zlATYJRPtHH/no_block_id/-OW9Al1ACsr3el2ZyHEV/thumbnail_file_sign_-OW9Al1ACsr3el2ZyHEV-imageglmge094tiowgtehi9wrgeyniothdhhd.jpg",
"type": "image/jpeg",
"url": "https://firebasestorage.googleapis.com/v0/b/farebin-af40f.appspot.com/o/files%2F1cUNHgbK23_Company%2F-OW8eEDU0zlATYJRPtHH%2Fno_block_id%2F-OW9Al1ACsr3el2ZyHEV%2Ffile_sign_-OW9Al1ACsr3el2ZyHEV-imageglmge094tiowgtehi9wrgeyniothdhhd.jpg?alt=media&token=c073abca-f1e7-4ad7-a3a9-df9a7fba9903",
"w": 515
}
},
"order": [
"-OW9Al1ACsr3el2ZyHEV"
]
},
"entity": "123example_Company",
"ersd": {
"enabled": true,
"terms": "..."
},
"expiration": "3",
"fields": {
"-OW9AoeUw_WXzroqqtVT": {
"fileID": "-OW9Al1ACsr3el2ZyHEV",
"font": "carlito",
"fontSize": "12",
"fontWeight": "normal",
"id": "-OW9AoeUw_WXzroqqtVT",
"page": 1,
"pageNumber": 1,
"placeholder": "Signature",
"required": true,
"signerID": "-OW99gU-7qNJWt_p2Ikp",
"signerName": "John Doe",
"title": "Signature1",
"type": "type_signature",
"value": ""
},
"-OW9Aq1KfbaCCNJbrZMo": {
"fileID": "-OW9Al1ACsr3el2ZyHEV",
"font": "carlito",
"fontSize": "12",
"fontWeight": "normal",
"id": "-OW9Aq1KfbaCCNJbrZMo",
"page": 1,
"pageNumber": 1,
"placeholder": "Signature",
"required": true,
"signature_type": "uploaded",
"signed_at": 1754343443037,
"signed_by": "-OW99eqH_zbfi2FpLbZR",
"signerID": "-OW99eqH_zbfi2FpLbZR",
"signerName": "Alice Walker",
"title": "Signature2",
"type": "type_signature",
"value": "https://firebasestorage.googleapis.com/v0/b/farebin-af40f.appspot.com/o/files%2F1cUNHgbK23_Company%2F-OW8eEDU0zlATYJRPtHH%2F-OW99eqH_zbfi2FpLbZR%2F-OWr-EGtpl-qWnSEUTlS.jpeg?alt=media&token=a96a5f39-fc82-4938-af08-419c40880b96"
},
"-OW9AtZayV5XJi4iWX13": {
"date_format": "mm_dd_yyyy",
"fileID": "-OW9Al1ACsr3el2ZyHEV",
"font": "carlito",
"fontSize": "12",
"fontWeight": "normal",
"id": "-OW9AtZayV5XJi4iWX13",
"page": 1,
"pageNumber": 1,
"required": true,
"signerID": "-OW99eqH_zbfi2FpLbZR",
"signerName": "Alice Walker",
"title": "field3",
"type": "type_date",
"value": 1754188125025
}
},
"multi_clients": true,
"new_pdf_name": "New Untitled Renamed2",
"progress": 100,
"reminders": "1",
"sent_date": 1754184835919,
"sign_in_order": true,
"signers": {
"order": [
"-OW99eqH_zbfi2FpLbZR",
"-OW99gU-7qNJWt_p2Ikp"
],
"sign_in_order": true,
"signers": {
"-OW99eqH_zbfi2FpLbZR": {
"company": "",
"device": "desktop",
"email": "alice.walker@mail.com",
"ip": "172.16.0.100",
"label": "",
"login": false,
"name": "Alice Walker",
"sent_date": 1754184836824,
"signed_date": 1754343458046,
"status": "signed",
"terms_agreed_date": 1754189236792,
"type": "type_signer",
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 13_2) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.2 Safari/605.1.15",
"viewed_date": 1754188127782
},
"-OW99gU-7qNJWt_p2Ikp": {
"company": "",
"declined_date": 1754403390150,
"declined_reason": "I don’t agree with the terms outlined in the document",
"device": "desktop",
"email": "john@example.com",
"ip": "192.168.1.1",
"label": "",
"login": false,
"name": "John Doe",
"sent_date": 1754343464477,
"status": "declined",
"type": "type_signer",
"userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/138.0.0.0 Safari/537.36",
"viewed_date": 1754343976557
}
}
},
"status": "void",
"title": "New Untitled Renamed",
"declined_by": "-OW99gU-7qNJWt_p2Ikp",
"id": "-NfELlO0zlATYexampleID",
"owner": {
"company": "ACME & ACME Inc",
"email": "ben@acme.com",
"id": "-OcUNFCUWEgUIDk9YmbK23",
"name": "Ben Allen"
}
}
Response Payload:
| Property Name | Property Label | Type | Description |
|---|---|---|---|
| id | Document ID | text | Document ID of the document or request. |
| title | Signature Request Title | text | The title of the signature request. |
| status | Signature Request Status | text | Current status (e.g. sent, void, expired, complete, archived). |
| new_pdf_name | New Signature Request Name (if renamed) | text | The updated name if the request PDF was renamed. |
| expiration | Expiration (days from sent date) | text | Number of days until the request expires. |
| progress | Progress (%) | number | Completion percentage of the request. |
| multi_clients | Has Multiple Signers? | boolean | Indicates if more than one signer is included. |
| sign_in_order | Sign In Order (parallel vs sequential) | boolean | Whether signers must sign in sequence (true) or can sign in parallel (false). |
| sent_date | Sent Timestamp | number | Unix timestamp when the request was sent. |
| declined_by | Declined By (Signer ID) | text | The ID of the signer who declined the request that caused the trigger. |
| reminders | Reminder Interval (days) | text | Configured interval for reminder emails. |
| owner | Owner (sender) | collection | Details of the account/user who sent the request (ID, name, email, company). |
| files[] | Files | collection | List of files attached to the request, including name, type, URL, PDF URL, thumbnail, size, and dimensions. |
| fields[] | Fields | collection | Form fields placed in the documents, including IDs, titles, types, signer assignment, page numbers, values, font details, and signature metadata. |
| signers[] | Signers | collection | Details of recipients (signers or CCs), including name, email, company, label, status, activity timestamps, IP, user agent, and decline reason if applicable. |
| ersd_enabled | ERSD Enabled | boolean | Indicates if the Electronic Record and Signature Disclosure (ERSD) was shown/enabled. |
| ersd_terms | ERSD Terms (HTML) | text | The HTML content of the ERSD terms presented to signers. |
Does not trigger when the sender cancels the request and marks it as void.
Description:
Triggers when a signature request reaches its expiration date without being completed
Sample Response:
{
"documents": {
"files": {
"-OW9Al1ACsr3el2ZyHEV": {
"companyID": "123example_Company",
"h": 640,
"name": "imageglmge094tiowgtehi9wrgeyniothdhhd.jpg",
"pdf": "https://firebasestorage.googleapis.com/v0/b/farebin-af40f.appspot.com/o/files%2F1cUNHgbK23_Company/-O7bx0gZ0e_7AZmzx0t0-8ef4e9e136f810332300be59ea80757bd.pdf?alt=media",
"size": 25669,
"thumbnail": "https://firebasestorage.googleapis.com/v0/b/farebin-af40f.appspot.com/o/files/1cUNHgbK23_Company/-OW8eEDU0zlATYJRPtHH/no_block_id/-OW9Al1ACsr3el2ZyHEV/thumbnail_file_sign_-OW9Al1ACsr3el2ZyHEV-imageglmge094tiowgtehi9wrgeyniothdhhd.jpg",
"type": "image/jpeg",
"url": "https://firebasestorage.googleapis.com/v0/b/farebin-af40f.appspot.com/o/files%2F1cUNHgbK23_Company%2F-OW8eEDU0zlATYJRPtHH%2Fno_block_id%2F-OW9Al1ACsr3el2ZyHEV%2Ffile_sign_-OW9Al1ACsr3el2ZyHEV-imageglmge094tiowgtehi9wrgeyniothdhhd.jpg?alt=media&token=c073abca-f1e7-4ad7-a3a9-df9a7fba9903",
"w": 515
}
},
"order": [
"-OW9Al1ACsr3el2ZyHEV"
]
},
"entity": "123example_Company",
"ersd": {
"enabled": true,
"terms": "..."
},
"expiration": "3",
"fields": {
"-OW9AoeUw_WXzroqqtVT": {
"fileID": "-OW9Al1ACsr3el2ZyHEV",
"font": "carlito",
"fontSize": "12",
"fontWeight": "normal",
"id": "-OW9AoeUw_WXzroqqtVT",
"page": 1,
"pageNumber": 1,
"placeholder": "Signature",
"required": true,
"signerID": "-OW99gU-7qNJWt_p2Ikp",
"signerName": "John Doe",
"title": "Signature1",
"type": "type_signature",
"value": ""
},
"-OW9Aq1KfbaCCNJbrZMo": {
"fileID": "-OW9Al1ACsr3el2ZyHEV",
"font": "carlito",
"fontSize": "12",
"fontWeight": "normal",
"id": "-OW9Aq1KfbaCCNJbrZMo",
"page": 1,
"pageNumber": 1,
"placeholder": "Signature",
"required": true,
"signerID": "-OW99eqH_zbfi2FpLbZR",
"signerName": "Alice Walker",
"title": "Signature2",
"type": "type_signature",
"value": ""
},
"-OW9AtZayV5XJi4iWX13": {
"date_format": "mm_dd_yyyy",
"fileID": "-OW9Al1ACsr3el2ZyHEV",
"font": "carlito",
"fontSize": "12",
"fontWeight": "normal",
"id": "-OW9AtZayV5XJi4iWX13",
"page": 1,
"pageNumber": 1,
"required": true,
"signerID": "-OW99eqH_zbfi2FpLbZR",
"signerName": "Alice Walker",
"title": "field3",
"type": "type_date"
}
},
"multi_clients": true,
"new_pdf_name": "New Untitled Renamed2",
"progress": 0,
"reminders": "1",
"sent_date": 1754184835919,
"sign_in_order": true,
"signers": {
"order": [
"-OW99eqH_zbfi2FpLbZR",
"-OW99gU-7qNJWt_p2Ikp"
],
"sign_in_order": true,
"signers": {
"-OW99eqH_zbfi2FpLbZR": {
"company": "",
"email": "alice.walker@mail.com",
"label": "",
"login": false,
"name": "Alice Walker",
"sent_date": 1754184836824,
"status": "sent",
"type": "type_signer"
},
"-OW99gU-7qNJWt_p2Ikp": {
"company": "",
"email": "john@example.com",
"label": "",
"login": false,
"name": "John Doe",
"type": "type_signer"
}
}
},
"status": "expired",
"expire_time": 1754462035000,
"title": "New Untitled Renamed",
"id": "-NfELlO0zlATYexampleID",
"owner": {
"company": "ACME & ACME Inc",
"email": "ben@acme.com",
"id": "-OcUNFCUWEgUIDk9YmbK23",
"name": "Ben Allen"
}
}
Response Payload:
| Property Name | Property Label | Type | Description |
|---|---|---|---|
| id | Document ID | text | Document ID of the document or request. |
| title | Signature Request Title | text | The title of the signature request. |
| status | Signature Request Status | text | Current status (e.g. sent, void, expired, complete, archived). |
| new_pdf_name | New Signature Request Name (if renamed) | text | The updated name if the request PDF was renamed. |
| expiration | Expiration (days from sent date) | text | Number of days until the request expires. |
| progress | Progress (%) | number | Completion percentage of the request. |
| multi_clients | Has Multiple Signers? | boolean | Indicates if more than one signer is included. |
| sign_in_order | Sign In Order (parallel vs sequential) | boolean | Whether signers must sign in sequence (true) or can sign in parallel (false). |
| sent_date | Sent Timestamp | number | Unix timestamp when the request was sent. |
| expire_time | Expired Timestamp | number | Unix timestamp when the request expired. |
| reminders | Reminder Interval (days) | text | Configured interval for reminder emails. |
| owner | Owner (sender) | collection | Details of the account/user who sent the request (ID, name, email, company). |
| files[] | Files | collection | List of files attached to the request, including name, type, URL, PDF URL, thumbnail, size, and dimensions. |
| fields[] | Fields | collection | Form fields placed in the documents, including IDs, titles, types, signer assignment, page numbers, values, font details, and signature metadata. |
| signers[] | Signers | collection | Details of recipients (signers or CCs), including name, email, company, label, status, activity timestamps, IP, user agent, and decline reason if applicable. |
| ersd_enabled | ERSD Enabled | boolean | Indicates if the Electronic Record and Signature Disclosure (ERSD) was shown/enabled. |
| ersd_terms | ERSD Terms (HTML) | text | The HTML content of the ERSD terms presented to signers. |
Description:
Triggers when a signature request is sent.
Sample Response:
{
"documents": {
"files": {
"-OW9Al1ACsr3el2ZyHEV": {
"companyID": "123example_Company",
"h": 640,
"name": "imageglmge094tiowgtehi9wrgeyniothdhhd.jpg",
"pdf": "https://firebasestorage.googleapis.com/v0/b/farebin-af40f.appspot.com/o/files%2F1cUNHgbK23_Company/-O7bx0gZ0e_7AZmzx0t0-8ef4e9e136f810332300be59ea80757bd.pdf?alt=media",
"size": 25669,
"thumbnail": "https://firebasestorage.googleapis.com/v0/b/farebin-af40f.appspot.com/o/files/1cUNHgbK23_Company/-OW8eEDU0zlATYJRPtHH/no_block_id/-OW9Al1ACsr3el2ZyHEV/thumbnail_file_sign_-OW9Al1ACsr3el2ZyHEV-imageglmge094tiowgtehi9wrgeyniothdhhd.jpg",
"type": "image/jpeg",
"url": "https://firebasestorage.googleapis.com/v0/b/farebin-af40f.appspot.com/o/files%2F1cUNHgbK23_Company%2F-OW8eEDU0zlATYJRPtHH%2Fno_block_id%2F-OW9Al1ACsr3el2ZyHEV%2Ffile_sign_-OW9Al1ACsr3el2ZyHEV-imageglmge094tiowgtehi9wrgeyniothdhhd.jpg?alt=media&token=c073abca-f1e7-4ad7-a3a9-df9a7fba9903",
"w": 515
}
},
"order": [
"-OW9Al1ACsr3el2ZyHEV"
]
},
"entity": "123example_Company",
"ersd": {
"enabled": true,
"terms": "..."
},
"expiration": "3",
"fields": {
"-OW9AoeUw_WXzroqqtVT": {
"fileID": "-OW9Al1ACsr3el2ZyHEV",
"font": "carlito",
"fontSize": "12",
"fontWeight": "normal",
"id": "-OW9AoeUw_WXzroqqtVT",
"page": 1,
"pageNumber": 1,
"placeholder": "Signature",
"required": true,
"signerID": "-OW99gU-7qNJWt_p2Ikp",
"signerName": "John Doe",
"title": "Signature1",
"type": "type_signature",
"value": ""
},
"-OW9Aq1KfbaCCNJbrZMo": {
"fileID": "-OW9Al1ACsr3el2ZyHEV",
"font": "carlito",
"fontSize": "12",
"fontWeight": "normal",
"id": "-OW9Aq1KfbaCCNJbrZMo",
"page": 1,
"pageNumber": 1,
"placeholder": "Signature",
"required": true,
"signerID": "-OW99eqH_zbfi2FpLbZR",
"signerName": "Alice Walker",
"title": "Signature2",
"type": "type_signature",
"value": ""
},
"-OW9AtZayV5XJi4iWX13": {
"date_format": "mm_dd_yyyy",
"fileID": "-OW9Al1ACsr3el2ZyHEV",
"font": "carlito",
"fontSize": "12",
"fontWeight": "normal",
"id": "-OW9AtZayV5XJi4iWX13",
"page": 1,
"pageNumber": 1,
"required": true,
"signerID": "-OW99eqH_zbfi2FpLbZR",
"signerName": "Alice Walker",
"title": "field3",
"type": "type_date"
}
},
"multi_clients": true,
"new_pdf_name": "New Untitled Renamed2",
"progress": 0,
"reminders": "1",
"sent_date": 1754184835919,
"sign_in_order": true,
"signers": {
"order": [
"-OW99eqH_zbfi2FpLbZR",
"-OW99gU-7qNJWt_p2Ikp"
],
"sign_in_order": true,
"signers": {
"-OW99eqH_zbfi2FpLbZR": {
"company": "",
"email": "alice.walker@mail.com",
"label": "",
"login": false,
"name": "Alice Walker",
"sent_date": 1754184836824,
"status": "sent",
"type": "type_signer"
},
"-OW99gU-7qNJWt_p2Ikp": {
"company": "",
"email": "john@example.com",
"label": "",
"login": false,
"name": "John Doe",
"type": "type_signer"
}
}
},
"status": "sent",
"title": "New Untitled Renamed",
"id": "-NfELlO0zlATYexampleID",
"owner": {
"company": "ACME & ACME Inc",
"email": "ben@acme.com",
"id": "-OcUNFCUWEgUIDk9YmbK23",
"name": "Ben Allen"
}
}
Response Payload:
| Property Name | Property Label | Type | Description |
|---|---|---|---|
| id | Document ID | text | Document ID of the document or request. |
| title | Signature Request Title | text | The title of the signature request. |
| status | Signature Request Status | text | Current status (e.g. sent, void, expired, complete, archived). |
| new_pdf_name | New Signature Request Name (if renamed) | text | The updated name if the request PDF was renamed. |
| expiration | Expiration (days from sent date) | text | Number of days until the request expires. |
| progress | Progress (%) | number | Completion percentage of the request. |
| multi_clients | Has Multiple Signers? | boolean | Indicates if more than one signer is included. |
| sign_in_order | Sign In Order (parallel vs sequential) | boolean | Whether signers must sign in sequence (true) or can sign in parallel (false). |
| sent_date | Sent Timestamp | number | Unix timestamp when the request was sent. |
| reminders | Reminder Interval (days) | text | Configured interval for reminder emails. |
| owner | Owner (sender) | collection | Details of the account/user who sent the request (ID, name, email, company). |
| files[] | Files | collection | List of files attached to the request, including name, type, URL, PDF URL, thumbnail, size, and dimensions. |
| fields[] | Fields | collection | Form fields placed in the documents, including IDs, titles, types, signer assignment, page numbers, values, font details, and signature metadata. |
| signers[] | Signers | collection | Details of recipients (signers or CCs), including name, email, company, label, status, activity timestamps, IP, user agent, and decline reason if applicable. |
| ersd_enabled | ERSD Enabled | boolean | Indicates if the Electronic Record and Signature Disclosure (ERSD) was shown/enabled. |
| ersd_terms | ERSD Terms (HTML) | text | The HTML content of the ERSD terms presented to signers. |
Description:
Triggers when a signature request is signed, either by a signer or when self-signed.
Sample Response:
{
"documents": {
"files": {
"-OW9Al1ACsr3el2ZyHEV": {
"companyID": "123example_Company",
"h": 640,
"name": "imageglmge094tiowgtehi9wrgeyniothdhhd.jpg",
"pdf": "https://firebasestorage.googleapis.com/v0/b/farebin-af40f.appspot.com/o/files%2F1cUNHgbK23_Company/-O7bx0gZ0e_7AZmzx0t0-8ef4e9e136f810332300be59ea80757bd.pdf?alt=media",
"size": 25669,
"thumbnail": "https://firebasestorage.googleapis.com/v0/b/farebin-af40f.appspot.com/o/files/1cUNHgbK23_Company/-OW8eEDU0zlATYJRPtHH/no_block_id/-OW9Al1ACsr3el2ZyHEV/thumbnail_file_sign_-OW9Al1ACsr3el2ZyHEV-imageglmge094tiowgtehi9wrgeyniothdhhd.jpg",
"type": "image/jpeg",
"url": "https://firebasestorage.googleapis.com/v0/b/farebin-af40f.appspot.com/o/files%2F1cUNHgbK23_Company%2F-OW8eEDU0zlATYJRPtHH%2Fno_block_id%2F-OW9Al1ACsr3el2ZyHEV%2Ffile_sign_-OW9Al1ACsr3el2ZyHEV-imageglmge094tiowgtehi9wrgeyniothdhhd.jpg?alt=media&token=c073abca-f1e7-4ad7-a3a9-df9a7fba9903",
"w": 515
}
},
"order": [
"-OW9Al1ACsr3el2ZyHEV"
]
},
"entity": "123example_Company",
"ersd": {
"enabled": true,
"terms": "..."
},
"expiration": "3",
"fields": {
"-OW9AoeUw_WXzroqqtVT": {
"fileID": "-OW9Al1ACsr3el2ZyHEV",
"font": "carlito",
"fontSize": "12",
"fontWeight": "normal",
"id": "-OW9AoeUw_WXzroqqtVT",
"page": 1,
"pageNumber": 1,
"placeholder": "Signature",
"required": true,
"signerID": "-OW99gU-7qNJWt_p2Ikp",
"signerName": "John Doe",
"title": "Signature1",
"type": "type_signature",
"value": ""
},
"-OW9Aq1KfbaCCNJbrZMo": {
"fileID": "-OW9Al1ACsr3el2ZyHEV",
"font": "carlito",
"fontSize": "12",
"fontWeight": "normal",
"id": "-OW9Aq1KfbaCCNJbrZMo",
"page": 1,
"pageNumber": 1,
"placeholder": "Signature",
"required": true,
"signature_type": "uploaded",
"signed_at": 1754343443037,
"signed_by": "-OW99eqH_zbfi2FpLbZR",
"signerID": "-OW99eqH_zbfi2FpLbZR",
"signerName": "Alice Walker",
"title": "Signature2",
"type": "type_signature",
"value": "https://firebasestorage.googleapis.com/v0/b/farebin-af40f.appspot.com/o/files%2F1cUNHgbK23_Company%2F-OW8eEDU0zlATYJRPtHH%2F-OW99eqH_zbfi2FpLbZR%2F-OWr-EGtpl-qWnSEUTlS.jpeg?alt=media&token=a96a5f39-fc82-4938-af08-419c40880b96"
},
"-OW9AtZayV5XJi4iWX13": {
"date_format": "mm_dd_yyyy",
"fileID": "-OW9Al1ACsr3el2ZyHEV",
"font": "carlito",
"fontSize": "12",
"fontWeight": "normal",
"id": "-OW9AtZayV5XJi4iWX13",
"page": 1,
"pageNumber": 1,
"required": true,
"signerID": "-OW99eqH_zbfi2FpLbZR",
"signerName": "Alice Walker",
"title": "field3",
"type": "type_date",
"value": 1754188125025
}
},
"multi_clients": true,
"new_pdf_name": "New Untitled Renamed2",
"progress": 66.67,
"reminders": "1",
"sent_date": 1754184835919,
"sign_in_order": true,
"signers": {
"order": [
"-OW99eqH_zbfi2FpLbZR",
"-OW99gU-7qNJWt_p2Ikp"
],
"sign_in_order": true,
"signers": {
"-OW99eqH_zbfi2FpLbZR": {
"company": "",
"device": "desktop",
"email": "alice.walker@mail.com",
"ip": "172.16.0.100",
"label": "",
"login": false,
"name": "Alice Walker",
"sent_date": 1754184836824,
"signed_date": 1754343458046,
"status": "signed",
"terms_agreed_date": 1754189236792,
"type": "type_signer",
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 13_2) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.2 Safari/605.1.15",
"viewed_date": 1754188127782
},
"-OW99gU-7qNJWt_p2Ikp": {
"company": "",
"email": "john@example.com",
"label": "",
"login": false,
"name": "John Doe",
"sent_date": 1754343464477,
"status": "sent",
"type": "type_signer"
}
}
},
"status": "sent",
"title": "New Untitled Renamed",
"id": "-NfELlO0zlATYexampleID",
"signed_date": 1754343458046,
"signed_by": "-OW99eqH_zbfi2FpLbZR",
"owner": {
"company": "ACME & ACME Inc",
"email": "ben@acme.com",
"id": "-OcUNFCUWEgUIDk9YmbK23",
"name": "Ben Allen"
}
}
Response Payload:
| Property Name | Property Label | Type | Description |
|---|---|---|---|
| id | Document ID | text | Document ID of the document or request. |
| title | Signature Request Title | text | The title of the signature request. |
| status | Signature Request Status | text | Current status (e.g. sent, void, expired, complete, archived). |
| new_pdf_name | New Signature Request Name (if renamed) | text | The updated name if the request PDF was renamed. |
| expiration | Expiration (days from sent date) | text | Number of days until the request expires. |
| progress | Progress (%) | number | Completion percentage of the request. |
| multi_clients | Has Multiple Signers? | boolean | Indicates if more than one signer is included. |
| sign_in_order | Sign In Order (parallel vs sequential) | boolean | Whether signers must sign in sequence (true) or can sign in parallel (false). |
| sent_date | Sent Timestamp | number | Unix timestamp when the request was sent. |
| signed_date | Signed Timestamp | number | Unix timestamp when the request was signed. |
| signed_by | Signed By (Signer ID) | text | The ID of the signer who has signed the request that caused the trigger. |
| reminders | Reminder Interval (days) | text | Configured interval for reminder emails. |
| owner | Owner (sender) | collection | Details of the account/user who sent the request (ID, name, email, company). |
| files[] | Files | collection | List of files attached to the request, including name, type, URL, PDF URL, thumbnail, size, and dimensions. |
| fields[] | Fields | collection | Form fields placed in the documents, including IDs, titles, types, signer assignment, page numbers, values, font details, and signature metadata. |
| signers[] | Signers | collection | Details of recipients (signers or CCs), including name, email, company, label, status, activity timestamps, IP, user agent, and decline reason if applicable. |
| ersd_enabled | ERSD Enabled | boolean | Indicates if the Electronic Record and Signature Disclosure (ERSD) was shown/enabled. |
| ersd_terms | ERSD Terms (HTML) | text | The HTML content of the ERSD terms presented to signers. |
Note: Triggers more than once if the request is signed multiple times.
Triggers whenever a signature request is signed, either by a signer or when self-signed (by you or your team).
Description:
Triggers when a signature request is viewed by a signer or CC’d recipient.
Sample Response:
{
"documents": {
"files": {
"-OW9Al1ACsr3el2ZyHEV": {
"companyID": "123example_Company",
"h": 640,
"name": "imageglmge094tiowgtehi9wrgeyniothdhhd.jpg",
"pdf": "https://firebasestorage.googleapis.com/v0/b/farebin-af40f.appspot.com/o/files%2F1cUNHgbK23_Company/-O7bx0gZ0e_7AZmzx0t0-8ef4e9e136f810332300be59ea80757bd.pdf?alt=media",
"size": 25669,
"thumbnail": "https://firebasestorage.googleapis.com/v0/b/farebin-af40f.appspot.com/o/files/1cUNHgbK23_Company/-OW8eEDU0zlATYJRPtHH/no_block_id/-OW9Al1ACsr3el2ZyHEV/thumbnail_file_sign_-OW9Al1ACsr3el2ZyHEV-imageglmge094tiowgtehi9wrgeyniothdhhd.jpg",
"type": "image/jpeg",
"url": "https://firebasestorage.googleapis.com/v0/b/farebin-af40f.appspot.com/o/files%2F1cUNHgbK23_Company%2F-OW8eEDU0zlATYJRPtHH%2Fno_block_id%2F-OW9Al1ACsr3el2ZyHEV%2Ffile_sign_-OW9Al1ACsr3el2ZyHEV-imageglmge094tiowgtehi9wrgeyniothdhhd.jpg?alt=media&token=c073abca-f1e7-4ad7-a3a9-df9a7fba9903",
"w": 515
}
},
"order": [
"-OW9Al1ACsr3el2ZyHEV"
]
},
"entity": "123example_Company",
"ersd": {
"enabled": true,
"terms": "..."
},
"expiration": "3",
"fields": {
"-OW9AoeUw_WXzroqqtVT": {
"fileID": "-OW9Al1ACsr3el2ZyHEV",
"font": "carlito",
"fontSize": "12",
"fontWeight": "normal",
"id": "-OW9AoeUw_WXzroqqtVT",
"page": 1,
"pageNumber": 1,
"placeholder": "Signature",
"required": true,
"signerID": "-OW99gU-7qNJWt_p2Ikp",
"signerName": "John Doe",
"title": "Signature1",
"type": "type_signature",
"value": ""
},
"-OW9Aq1KfbaCCNJbrZMo": {
"fileID": "-OW9Al1ACsr3el2ZyHEV",
"font": "carlito",
"fontSize": "12",
"fontWeight": "normal",
"id": "-OW9Aq1KfbaCCNJbrZMo",
"page": 1,
"pageNumber": 1,
"placeholder": "Signature",
"required": true,
"signerID": "-OW99eqH_zbfi2FpLbZR",
"signerName": "Alice Walker",
"title": "Signature2",
"type": "type_signature",
"value": ""
},
"-OW9AtZayV5XJi4iWX13": {
"date_format": "mm_dd_yyyy",
"fileID": "-OW9Al1ACsr3el2ZyHEV",
"font": "carlito",
"fontSize": "12",
"fontWeight": "normal",
"id": "-OW9AtZayV5XJi4iWX13",
"page": 1,
"pageNumber": 1,
"required": true,
"signerID": "-OW99eqH_zbfi2FpLbZR",
"signerName": "Alice Walker",
"title": "field3",
"type": "type_date"
}
},
"multi_clients": true,
"new_pdf_name": "New Untitled Renamed2",
"progress": 0,
"reminders": "1",
"sent_date": 1754184835919,
"sign_in_order": true,
"signers": {
"order": [
"-OW99eqH_zbfi2FpLbZR",
"-OW99gU-7qNJWt_p2Ikp"
],
"sign_in_order": true,
"signers": {
"-OW99eqH_zbfi2FpLbZR": {
"company": "",
"email": "alice.walker@mail.com",
"label": "",
"login": false,
"name": "Alice Walker",
"sent_date": 1754184836824,
"viewed_date": 1754189936824,
"status": "sent",
"type": "type_signer"
},
"-OW99gU-7qNJWt_p2Ikp": {
"company": "",
"email": "john@example.com",
"label": "",
"login": false,
"name": "John Doe",
"type": "type_signer"
}
}
},
"status": "sent",
"title": "New Untitled Renamed",
"id": "-NfELlO0zlATYexampleID",
"viewed_by": "-OW99eqH_zbfi2FpLbZR",
"viewed_date": 1754189936824,
"owner": {
"company": "ACME & ACME Inc",
"email": "ben@acme.com",
"id": "-OcUNFCUWEgUIDk9YmbK23",
"name": "Ben Allen"
}
}
Response Payload:
| Property Name | Property Label | Type | Description |
|---|---|---|---|
| id | Document ID | text | Document ID of the document or request. |
| title | Signature Request Title | text | The title of the signature request. |
| status | Signature Request Status | text | Current status (e.g. sent, void, expired, complete, archived). |
| new_pdf_name | New Signature Request Name (if renamed) | text | The updated name if the request PDF was renamed. |
| expiration | Expiration (days from sent date) | text | Number of days until the request expires. |
| progress | Progress (%) | number | Completion percentage of the request. |
| multi_clients | Has Multiple Signers? | boolean | Indicates if more than one signer is included. |
| sign_in_order | Sign In Order (parallel vs sequential) | boolean | Whether signers must sign in sequence (true) or can sign in parallel (false). |
| sent_date | Sent Timestamp | number | Unix timestamp when the request was sent. |
| viewed_date | Viewed Timestamp | number | Unix timestamp when the request was viewed. |
| viewed_by | Viewed By (Signer ID) | text | The ID of the signer who has viewed the request that caused the trigger. |
| reminders | Reminder Interval (days) | text | Configured interval for reminder emails. |
| owner | Owner (sender) | collection | Details of the account/user who sent the request (ID, name, email, company). |
| files[] | Files | collection | List of files attached to the request, including name, type, URL, PDF URL, thumbnail, size, and dimensions. |
| fields[] | Fields | collection | Form fields placed in the documents, including IDs, titles, types, signer assignment, page numbers, values, font details, and signature metadata. |
| signers[] | Signers | collection | Details of recipients (signers or CCs), including name, email, company, label, status, activity timestamps, IP, user agent, and decline reason if applicable. |
| ersd_enabled | ERSD Enabled | boolean | Indicates if the Electronic Record and Signature Disclosure (ERSD) was shown/enabled. |
| ersd_terms | ERSD Terms (HTML) | text | The HTML content of the ERSD terms presented to signers. |
Description:
Triggers when all signers have completed signing and the final signed PDF is ready.
Sample Response:
{
"documents": {
"files": {
"-OW9Al1ACsr3el2ZyHEV": {
"companyID": "123example_Company",
"h": 640,
"name": "imageglmge094tiowgtehi9wrgeyniothdhhd.jpg",
"pdf": "https://firebasestorage.googleapis.com/v0/b/farebin-af40f.appspot.com/o/files%2F1cUNHgbK23_Company/-O7bx0gZ0e_7AZmzx0t0-8ef4e9e136f810332300be59ea80757bd.pdf?alt=media",
"size": 25669,
"thumbnail": "https://firebasestorage.googleapis.com/v0/b/farebin-af40f.appspot.com/o/files/1cUNHgbK23_Company/-OW8eEDU0zlATYJRPtHH/no_block_id/-OW9Al1ACsr3el2ZyHEV/thumbnail_file_sign_-OW9Al1ACsr3el2ZyHEV-imageglmge094tiowgtehi9wrgeyniothdhhd.jpg",
"type": "image/jpeg",
"url": "https://firebasestorage.googleapis.com/v0/b/farebin-af40f.appspot.com/o/files%2F1cUNHgbK23_Company%2F-OW8eEDU0zlATYJRPtHH%2Fno_block_id%2F-OW9Al1ACsr3el2ZyHEV%2Ffile_sign_-OW9Al1ACsr3el2ZyHEV-imageglmge094tiowgtehi9wrgeyniothdhhd.jpg?alt=media&token=c073abca-f1e7-4ad7-a3a9-df9a7fba9903",
"w": 515
}
},
"order": [
"-OW9Al1ACsr3el2ZyHEV"
]
},
"entity": "123example_Company",
"ersd": {
"enabled": true,
"terms": "..."
},
"expiration": "3",
"fields": {
"-OW9AoeUw_WXzroqqtVT": {
"fileID": "-OW9Al1ACsr3el2ZyHEV",
"font": "carlito",
"fontSize": "12",
"fontWeight": "normal",
"id": "-OW9AoeUw_WXzroqqtVT",
"page": 1,
"pageNumber": 1,
"placeholder": "Signature",
"required": true,
"signature_type": "typed",
"signed_at": 1754403383246,
"signed_by": "-OW99gU-7qNJWt_p2Ikp",
"signerID": "-OW99gU-7qNJWt_p2Ikp",
"signerName": "John Doe",
"title": "Signature1",
"type": "type_signature",
"value": "https://firebasestorage.googleapis.com/v0/b/farebin-af40f.appspot.com/o/files%2F1cUNHgbK23_Company%2F-OW8eEDU0zlATYJRPtHH%2F-OW99gU-7qNJWt_p2Ikp%2F-OWu_mQ8JV0Hkk54BTv-.jpeg?alt=media&token=0c63bd24-efc3-40c9-866c-1c94ee307619"
},
"-OW9Aq1KfbaCCNJbrZMo": {
"fileID": "-OW9Al1ACsr3el2ZyHEV",
"font": "carlito",
"fontSize": "12",
"fontWeight": "normal",
"id": "-OW9Aq1KfbaCCNJbrZMo",
"page": 1,
"pageNumber": 1,
"placeholder": "Signature",
"required": true,
"signature_type": "uploaded",
"signed_at": 1754343443037,
"signed_by": "-OW99eqH_zbfi2FpLbZR",
"signerID": "-OW99eqH_zbfi2FpLbZR",
"signerName": "Alice Walker",
"title": "Signature2",
"type": "type_signature",
"value": "https://firebasestorage.googleapis.com/v0/b/farebin-af40f.appspot.com/o/files%2F1cUNHgbK23_Company%2F-OW8eEDU0zlATYJRPtHH%2F-OW99eqH_zbfi2FpLbZR%2F-OWr-EGtpl-qWnSEUTlS.jpeg?alt=media&token=a96a5f39-fc82-4938-af08-419c40880b96"
},
"-OW9AtZayV5XJi4iWX13": {
"date_format": "mm_dd_yyyy",
"fileID": "-OW9Al1ACsr3el2ZyHEV",
"font": "carlito",
"fontSize": "12",
"fontWeight": "normal",
"id": "-OW9AtZayV5XJi4iWX13",
"page": 1,
"pageNumber": 1,
"required": true,
"signerID": "-OW99eqH_zbfi2FpLbZR",
"signerName": "Alice Walker",
"title": "field3",
"type": "type_date",
"value": 1754188125025
}
},
"multi_clients": true,
"new_pdf_name": "New Untitled Renamed2",
"progress": 100,
"reminders": "1",
"sent_date": 1754184835919,
"sign_in_order": true,
"signers": {
"order": [
"-OW99eqH_zbfi2FpLbZR",
"-OW99gU-7qNJWt_p2Ikp"
],
"sign_in_order": true,
"signers": {
"-OW99eqH_zbfi2FpLbZR": {
"company": "",
"device": "desktop",
"email": "alice.walker@mail.com",
"ip": "172.16.0.100",
"label": "",
"login": false,
"name": "Alice Walker",
"sent_date": 1754184836824,
"signed_date": 1754343458046,
"status": "signed",
"terms_agreed_date": 1754189236792,
"type": "type_signer",
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 13_2) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.2 Safari/605.1.15",
"viewed_date": 1754188127782
},
"-OW99gU-7qNJWt_p2Ikp": {
"company": "",
"device": "desktop",
"email": "john@example.com",
"ip": "192.168.1.1",
"label": "",
"login": false,
"name": "John Doe",
"sent_date": 1754343464477,
"signed_date": 1754344976959,
"status": "signed",
"terms_agreed_date": 1754343996587,
"type": "type_signer",
"userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/138.0.0.0 Safari/537.36",
"viewed_date": 1754343976557
}
}
},
"status": "complete",
"signed_pdf": "https://firebasestorage.googleapis.com/v0/b/farebin-af40f.appspot.com/o/files%2F1cUNHgbK23_Company%2F-OW8eEDU0zlATYJRPtHH%2F-OW99eqH_zbfi2FpLbZR%2Fsigned.pdf",
"coc": "https://firebasestorage.googleapis.com/v0/b/farebin-af40f.appspot.com/o/files%2F1cUNHgbK23_Company%2F-OW8eEDU0zlATYJRPtHH%2F-OW99eqH_zbfi2FpLbZR%2Fcoc.pdf",
"title": "New Untitled Renamed",
"id": "-NfELlO0zlATYexampleID",
"owner": {
"company": "ACME & ACME Inc",
"email": "ben@acme.com",
"id": "-OcUNFCUWEgUIDk9YmbK23",
"name": "Ben Allen"
}
}
Response Payload:
| Property Name | Property Label | Type | Description |
|---|---|---|---|
| id | Document ID | text | Document ID of the document or request. |
| title | Signature Request Title | text | The title of the signature request. |
| status | Signature Request Status | text | Current status (e.g. sent, void, expired, complete, archived). |
| new_pdf_name | New Signature Request Name (if renamed) | text | The updated name if the request PDF was renamed. |
| expiration | Expiration (days from sent date) | text | Number of days until the request expires. |
| progress | Progress (%) | number | Completion percentage of the request. |
| multi_clients | Has Multiple Signers? | boolean | Indicates if more than one signer is included. |
| sign_in_order | Sign In Order (parallel vs sequential) | boolean | Whether signers must sign in sequence (true) or can sign in parallel (false). |
| sent_date | Sent Timestamp | number | Unix timestamp when the request was sent. |
| signed_pdf | Signed PDF | text | The URL of the sealed PDF. |
| coc | Certificate of Completion | text | The URL of the certificate of completion (PDF). |
| reminders | Reminder Interval (days) | text | Configured interval for reminder emails. |
| owner | Owner (sender) | collection | Details of the account/user who sent the request (ID, name, email, company). |
| files[] | Files | collection | List of files attached to the request, including name, type, URL, PDF URL, thumbnail, size, and dimensions. |
| fields[] | Fields | collection | Form fields placed in the documents, including IDs, titles, types, signer assignment, page numbers, values, font details, and signature metadata. |
| signers[] | Signers | collection | Details of recipients (signers or CCs), including name, email, company, label, status, activity timestamps, IP, user agent, and decline reason if applicable. |
| ersd_enabled | ERSD Enabled | boolean | Indicates if the Electronic Record and Signature Disclosure (ERSD) was shown/enabled. |
| ersd_terms | ERSD Terms (HTML) | text | The HTML content of the ERSD terms presented to signers. |
Triggers only when all signers have completed signing and the final signed PDF is ready.
Actions
Description:
This action adds a new Client.
Request Body Payload:
| Property Name | Type | Description |
|---|---|---|
| name | text | The name of the client. |
| text | The email address of the client. | |
| phone | text | The phone number of the client. (optional) |
| company | text | The name of the company where the client works. (optional) |
| account_id | text | The unique identifier of your OkaySend account. |
Sample Response:
{
"name": "John Doe",
"email": "example@email.com",
"phone": "",
"company": "Acme Co.",
"created_at": 1702439585093,
"id": "-NlWIcIuho_bzkwXyVUu",
"account_id": "example1aCN3qJCDWuAPWdbK23_Company"
}
Response Payload:
| Property Name | Type | Description |
|---|---|---|
| name | text | The name of the client (e.g., "John Doe"). |
| text | The email address associated with the client (e.g., "example@email.com"). | |
| phone | text | The phone number associated with the client. Returns empty string, if no phone number was provided. |
| company | text | The name of the company or organization (e.g., "Acme Co."). Returns empty string, if no company name was provided. |
| id | text | A unique identifier for the client updated (e.g., "-NlWIcIuho_bzkwXyVUu"). |
| created_at | number | The timestamp indicating the date and time when the client record was created (e.g., 1690300434633). |
| account_id | text | The unique identifier of your OkaySend account (e.g., "example1aCN3qJCDWuAPWdbK23_Company"). |
Description:
This action creates a new Checklist and sends the request for info/files.
Request Body Payload:
| Property Name | Type | Description |
|---|---|---|
| title | text | The title or name of the request. |
| template | text | The template ID for the template to use to create the request. |
| login | boolean | Set to true if you require email verification from client(s) for access. |
| client | collection | The client ID used to find an exsisting client to send the request to. Will be a string or an array in the case where the request has multiple clients. (optional) |
| due_date | number | The deadline or due date associated with the request. Required if client is sent. |
| reminder_sched | collection | The schedule ID for the reminder schedule to use for the request. Required if client is sent. |
| account_id | text | The unique identifier for your OkaySend account. |
| uid | text | The unique identifier for the user (you) who is creating this request. |
Following is an example response from the Send a Document Request action in Make. It demonstrates the format and data structure you can expect when a new request is successfully created.
Sample Response:
{
"id": "-NmOn1FzhnHbmjargTXa",
"title": "New Example Request",
"account_id": "1cUNLlSo8xaCNaIjG4WlpHgbK2example",
"status": "sent",
"sent_date": 1703382739515,
"due_date": 1703894400000,
"link": "https://okaysend.com/u/request?id=-NmOn1FzhnHbmjargTXa",
"client": {
"company": "",
"created_at": 1690300289509,
"email": "joesgreen@gmail.com",
"id": "-NaCjpDMn8Fzh6GJez9J",
"name": "joes green",
"phone": "",
"timestamp": -1690300289310
},
"clients": {
"-NaCjpDMn8Fzh6GJez9J": {
"company": "",
"created_at": 1690300289509,
"email": "joesgreen@gmail.com",
"id": "-NaCjpDMn8Fzh6GJez9J",
"is_active": true,
"name": "joes green",
"phone": "",
"timestamp": -1690300289310
}
},
"login": false,
"multi_clients": false,
"reminder_sched": {
"sched": [
null,
{
"date": "submit",
"days": "0",
"when": "after"
}
],
"title": "No Follow-Up Reminders",
"sent_date": 1703382739515,
"due_date": 1703894400000
}
}
Response Payload:
| Property Name | Type | Description |
|---|---|---|
| id | text | The unique identifier for the request. |
| title | text | The title of the request, indicating its purpose or content (e.g., "New Example Request"). |
| account_id | text | The unique identifier of your OkaySend account. |
| status | text | The current status of the request (Will always be "sent"). |
| sent_date | number | The timestamp when the request was sent. |
| due_date | number | The deadline or due date for the request. (May not return a value) |
| link | text | The (public) link to access the request on OkaySend. You may send it to your client. |
| multi_clients | boolean | Will be set to true if the request was sent to multiple clients. |
| login | boolean | Will be set to true if the request requires email verification from all clients for access. |
| clients | collection | Information about all the clients, including name, email, and company. (May return an empty object) |
| client | collection | Information about the client, including name, email, and company. (May return an empty object) |
| reminder_sched | collection | Details about the reminder schedule for the request. (May return an empty object) |
You may create a Request without a Client. In that case, you'll be responsible for sharing the Request's link with your Client yourself.
Client's email will be used to check if the client already exists. If the client does not exist, a new client record will be created.
Note: Request will be marked as "Active" and may count against your Active Request quota. See: What is an active Request?
Note: Request becomes available to be filled out instantly and the status changes to "sent".
API Errors
OkaySend uses standard HTTP response codes to indicate the success or failure of a request.
Codes in the 2xx range indicate success, codes in the 4xx range indicate an error given the information provided (e.g. a required parameter was omitted), and codes in the 5xx range indicate an error with the OkaySend service itself.
| Parameter | Description |
|---|---|
| 400 | Bad Request - The request could not be understood due to malformed syntax. |
| 401 | Unauthorized - Your API key is wrong or the access token has expired. |
| 403 | Limit Reached - Please make requests inactive, permanently delete requests to clear space, or upgrade your account. |
| 404 | Not Found - The requested resource is not found. |
| 500 | Internal Error - Our servers encountered an unexpected error while fetching or updating data to our database. |
| 503 | Service Unavailable - We’re temporarily offline. Please try again later. |