Contact forms

Send lead information from flipbooks directly to your internal systems using webhooks.

You can now connect your own webhook endpoint to receive real-time lead data from your interactive flipbooks. Just provide the URL of your webhook, and every time a lead submits information using a contact form inside one of your flipbooks, we’ll send the data payload to your endpoint in JSON format.

Returned codes: when the webhook returns non 2xx codes, we will consider it a failed request and log the error message. Failed requests are found in the Webhook section of the Integrations page.

Restrictions

  • Only HTTPS endpoints are allowed

  • Max timeout: 10 seconds (typical)

  • Retry up to 5 times with exponential backoff

  • Disabled automatically after 5 failures

  • Webhook URL cannot require authentication

  • One webhook per workspace/account

Important attributes

Contact form JSON

Attribute
Type
Description

type

String

The type of the event. Make sure you always check the value before processing data you received. For contact forms, the value should be "contact" (other values may be supported in the future).

timestamp

Numeric

The timestamp value when the contact form data was received.

datetime

Datetime

The UTC date and time the contact form data was received by Flipsnack.

flipbook_hash

String

The hash of the flipbook that sent the contact form data. This hash can be used to identify the target flipbook using our API.

flipbook_title

String

The title of the flipbook that sent the contact form. You can use this information to easily identify which flipbook is the source for the contact form data.

data

Object

The data related to the contact form. It contains the information the lead has entered in the contact form. Each data entered by the lead has a field name (string) property and a field value (string).

Example:

Form data

Please note that the field names in the JSON data will be the ones you specified in the contact form setup as field names for the form. Also, your form may contain less fields or fields with different names.

Field name
Type
Description

Form name

String

The name of the form, as specified in the Contact form setup. This field is always set.

Email address

String

The email of the lead.

First name

String

The first name of the lead.

Last name

String

The last name of the lead.

Full name

String

The full name of the lead.

Phone number

String

The phone number of the lead.

Country/region

String

The country of the lead.

Website

String

The website of the lead.

Dropdown field

String

The value of the option selected in the drop down field.

Paragraph

String

The long form text entered by the lead in the paragraph field.

Custom input

String

The custom text entered by the lead in the custom input field.

Below is an example of the JSON structure sent for a sample custom form with default field names:

Last updated