Workspace
Setup for Botghost
To make submissions available on your Discord bot using BotGhost, follow these steps to set up the endpoint:
-
Select your Tally Form
Go to tally.so and select thee Form that you want to receive the submissions of.
-
Connect your Tally Form with the Webhooks Integration
Head over to the Integrations Tab and search for the ‘Webhooks’ Integration.
Intergrations
-
Setting up the Webhook
Now in the Webhooks Tab you will find the Endpoint URL Field. There you have to enter:
https://api.cookie-api.com/api/botghost/tally-submissions
Next click on ‘Add HTTP headers’ and then add 2 more HTTP headers by clicking ‘Add headers’ 2 times. Enter the following HTTP headers:
Name Value Authorization Your API Key BotghostUrl Your BotGhost Webhook URL BotghostKey Your BotGhost Webhook API Key Once you have done that, click on ‘Connect’
Webhook
Variables
Please note: All listed variables use {
question1
.type}
as an example. The prefix will vary based on the position of your element in the Tally Form, progressing as question1
, question2
, and so on.
Standard Variables
These Variables are available in every Submission:
Name | Variable | Description |
---|---|---|
Event ID | {eventId} | ID of the Webhook Event |
Event Type | {eventType} | Type of the Event |
Created At | {createdAt} | ISO Timestamp of the submission |
Response ID | {responseId} | Response ID |
Submission ID | {submissionId} | Submission ID |
Respondent ID | {respondentId} | Respondent ID |
Form ID | {formId} | ID of the Form |
Form Name | {formName} | Name of the Form |
Field Count | {FieldCount} | Returns the question count |
Standard Input Types
The following variables are applicable only to these element types:
- HIDDEN_FIELDS
- CALCULATED_FIELDS
- INPUT_TEXT
- INPUT_NUMBER
- INPUT_EMAIL
- INPUT_PHONE_NUMBER
- INPUT_LINK
- INPUT_DATE
- INPUT_TIME
- TEXTAREA
- RATING
- LINEAR_SCALE
Name | Variable | Description |
---|---|---|
Element Type | {question1.type} | Type of the Element |
Element Label | {question1.label} | Label (Name) of the Element |
Element Value | {question1.value} | Value of the Element |
Element Key | {question1.key} | Key of the Element |
Selection-Based Input Types
The following variables are applicable only to these element types:
- MULTIPLE_CHOICE
- CHECKBOXES
- DROPDOWN
- MULTI_SELECT
- RANKING
Name | Variable | Description |
---|---|---|
Element Type | {question1.type} | Type of the Element |
Element Label | {question1.label} | Label (Name) of the Element |
Element Key | {question1.key} | Key of the Element |
Element Values (ID) | {question1.value.id} | Value ID’s of the Element |
Element Values (Text) | {question1.value.text} | Values of the Element as Text |
Element Options (ID) | {question1.options.id} | Option ID’s of the Element |
Element Options (Text) | {question1.options.text} | Options of the Element as Text |
Text and IDs will be returned in the following format: ['Option1', 'Option2', ...]
Other Types
The following variables are applicable only to these element types:
- FILE_UPLOAD
- SIGNATURE
Name | Variable | Description |
---|---|---|
Element Type | {question1.type} | Type of the Element |
Element Label | {question1.label} | Label (Name) of the Element |
Element Value | {question1.value} | Value of the Element |
Element Key | {question1.key} | Key of the Element |
File Name | {question1.value.name} | Name of the File |
File URL | {question1.value.url} | URL of the File |
File Size | {question1.value.size} | Size of the File |
File Type | {question1.value.mimeType} | Type of the File |
Unsupported Types
This Endpoint doesn’t support the following Element Types:
- MATRIX
- PAYMENT