Skip to main content

Introduction

Pingback offers customizable and secure embeddable forms for easy integration into your website, eliminating the need to build forms from scratch.

These forms are designed to seamlessly collect data from your users with minimal effort.

Explore various implementations and get inspired by visiting our Demos page.

Setup​

Insert the following script tag in the <head> or <body> section of your HTML file to integrate Pingback into your website:

<script src="https://widget.pingback.com"></script>

Usage​

Embedding a Form​

Insert the below HTML snippet where you want the form to appear on your page:

<pb-embeddable-form channel_id="your_channel_id"></pb-embeddable-form>

Replace your_channel_id with the actual channel ID. If you're unsure of the channel ID, contact our support team.

Options​

All attributes can be set up without writing any code. Simply visit the Embed page in your Pingback account and copy the code snippet provided.

For those who want to dive deeper, you can customize the appearance and behavior of the form by adding additional attributes to the <pb-embeddable-form> tag. Below are some of the options you can configure:

Behavior​

  • channel_id: ID for the channel to use.
  • segment_id: (Optional) ID for the segment to use.
  • product_id: (Optional) ID for the product to use.

Customizing​

  • locale: Sets the form language (default: pt). Available languages: pt, en, es.
  • call_to_action: Text for the submit button (default: "Inscrever").
  • thanks_message: Message post form submission (default: "Inscrição realizada com sucesso!"). Use redirect_url to redirect users post submission.
  • redirect_url: (Optional) URL to redirect users after form submission.
  • theme_mode: light (default) or dark.
  • theme_color: Choose from predefined colors:
    • purple-classic (default)
    • mint
    • cyan
    • teal
    • blue
    • navy-blue
    • magenta
    • pink
    • indigo
    • green
    • lime
    • dark-green
    • scarlet
    • crimson
    • red
    • salmon
    • bronze
    • yellow
    • orange
    • black

Field Options​

Email is a required field. You can choose to show or hide the name and phone fields:

  • show_name: Show or hide the name field (default: false).
  • show_phone: Show or hide the phone field (default: false).

Custom Fields​

You can add custom fields to the form by using the ones that are available in your channel. If you don't know the available fields, you can ask our support team.

You can add up to 5 custom fields to the form. The attribute name should follow the pattern custom_field_<index>, where <index> is a number from 1 to 5.

The available attributes are:

  • custom_field_<index>_id: The ID of the custom field.
  • custom_field_<index>_type: The type of the custom field. Possible values are:
    • text
    • dropdown
  • custom_field_<index>_label: The label of the custom field.
  • custom_field_<index>_helper: The helper text of the custom field. Optional.
  • custom_field_<index>_options: The options of the custom field. Required for dropdown fields. Example: "Option 1, Option 2,Option 3".
  • custom_field_<index>_required: Whether the custom field is required. Default is false.
  • custom_field_<index>_placeholder: The placeholder text of the custom field. Optional.

Support​

If you have any questions or need help, please contact our support team.