Search results for api

49 articles found

  • Rest API Contacts

    Groundhogg provides the /contacts/ endpoint. The contacts endpoint allows users to query the contact table inside the database and let you perform operations on contacts. This endpoint supports GET,

  • REST API / Authentication

    The REST API Supports three different methods of authentication at this point in time. Groundhogg API Keys WordPress Application Passwords WordPress REST Nonce Groundhogg API Keys To use an API key

  • Plugin API REST Endpoint

    You can use the Plugin API REST endpoint as an alternative to the Webhook Listener if the contact has already been registered on your site. You can send a webhook request to this endpoint call_name,

  • REST API V4 / Deals

    The deals API lets you fetch, add, edit, and delete deals. Deal Properties Attribute Type Description ID integer The system ID of the deal data object The core properties of the deal contain

  • REST API V4 / Notes

    The notes API allows you to fetch, add, edit, and delete notes. Note Properties Attribute Type Description ID integer The system ID of the note data object The core properties of the note containing

  • REST API V4 / Contacts

    The contacts API allows you to fetch, add, edit, and delete contacts. Contact Properties Attribute Type Description ID integer The system ID of the contact data object The core properties of the

  • Elastic Email Integration: Connect email API

    Elastic Email says they can send emails faster and more reliably, you can make use of their REST API within Groundhogg to know yourself. One of the cool things about our integration is that with it,

  • REST API V3 / Tags / Delete

    URL DELETE /wp-json/gh/v3/tags Method This endpoint supports the DELETE method. Request To delete a tag you must pass these arguments. PARAM TYPE REQUIRED DESCRIPTION tag_id int yes The ID of the tag

  • REST API V3 / Tags / Edit

    URL PUT /wp-json/gh/v3/tags Method This endpoint supports the PUT method. Request This endpoint provides functionality to edit tags. PARAM TYPE REQUIRED DESCRIPTION tag_id int yes ID of a tag that

  • REST API V3 / Tags / Create

    URL POST /wp-json/gh/v3/tags Method This endpoint supports the POST method. Request You can create single or multiple tags using this endpoint. PARAM TYPE REQUIRED DESCRIPTION tags array yes Tag

  • REST API V3 / SMS / Get

    URL GET /wp-json/gh/v3/sms Method This endpoint supports the GET method. Request You can pass the search string to get SMS with that string. PARAM TYPE REQUIRED DESCRIPTION search string no String to

  • REST API V3 / Emails / Send

    URL POST /wp-json/gh/v3/emails/send Method This endpoint supports the POST method. Request This endpoint provides functionality to send email to the contact. PARAM TYPE REQUIRED DESCRIPTION

  • REST API V3 / Contact / Get

    URL GET /wp-json/gh/v3/contacts Method This endpoint supports the GET method Request This endpoint provides multiple ways of searching and retrieving contact information. Here are the parameters you

  • REST API V3 / Emails / Get

    URL GET /wp-json/gh/v3/emails Method This endpoint supports the GET method. Request You can pass the search string to get SMS with that string. PARAM TYPE REQUIRED DESCRIPTION search string no String

  • REST API V3 / Contact / Delete

    URL DELETE /wp-json/gh/v3/contacts Method This endpoint supports the DELETE method. Request To delete a contact record you must pass these arguments. PARAM TYPE REQUIRED EXAMPLE id_or_email string |

  • REST API V3 / Tags / Get

    URL GET /wp-json/gh/v3/tags Method This endpoint supports the GET method. Request You can pass the search string to get SMS with that string. PARAM TYPE REQUIRED DESCRIPTION search string no String

  • REST API V3 / SMS / Send

    URL POST /wp-json/gh/v3/sms/send Method This endpoint supports the POST method. Request This endpoint provides functionality to send SMS to the contact. PARAM TYPE REQUIRED DESCRIPTION id_or_email

  • REST API V3 / Contact / Update

    URL PUT|PATCH /wp-json/gh/v3/contacts Method This endpoint supports PUT or PATCH Request To update a contact record you must pass these arguments. PARAM TYPE REQUIRED EXAMPLE id_or_email string|int

  • REST API V3 / Contact / Create

    URI POST /wp-json/gh/v3/contacts Method This endpoint supports the POST method Request You can pass any relevant contact arguments to the contacts endpoint plus additional metadata. PARAM TYPE

  • REST API V3 / Tags / Manage

    URL Apply Tags PUT /wp-json/gh/v3/contacts/apply_tags or PUT /wp-json/gh/v3/tags/apply Remove Tags PUT /wp-json/gh/v3/contacts/apply_tags or PUT /wp-json/gh/v3/tags/remove Method This endpoint

  • Create your own custom benchmark using the Plugin API

    You could create your own custom benchmark, but as we routinely update the registration flow, and backwards compatibility is not always guaranteed. However, we do provide a future-proof method to

  • REST API V3 / Contacts / Tags / Get

    URL GET /wp-json/gh/v3/contacts/tags Method This endpoint supports the GET method. Request This endpoint provides functionality to get all the tags applied to the contact. PARAM TYPE REQUIRED

  • Postmark Integration: Connect to Postmark with the email API

    Basic SMTP can be slow, so Postmark has a REST API that can deliver emails much faster! How to setup Postmark Integration (included in plus plan or above) to deliver emails via the Postmark API.

  • SendGrid Integration: Connect to SendGrid with the email API

    Basic SMTP can be slow, so SendGrid has a REST API that can deliver emails much faster! Here is how you use our SendGrid integration (also included in plus plan or above) to deliver emails via the

  • Getting Started

    Groundhogg provides a REST API that allows users to retrieve data remotely using a JSON format. Using the RESTful API users can manage contacts, emails, SMS and tags remotely. By default, Groundhogg

  • SendGrid Integration: Create webhook event listener

    SendGrid can send events to your WordPress site which will inform Groundhogg if an email bounced or was marked as spam so that Groundhogg will no longer send emails to problematic contacts. The

  • Zapier Integration: Zap listener

    The Zap Listener is a benchmark that can listen for POSTS from Zapier to your site which contains contact information. You can place a Zap Listener anywhere in your funnel, but if the contact does

  • SMTP: Connect to Sendgrid

    If you are using SendGrid with the SMTP extension please follow these steps. Navigate to the Email API Screen and select SMTP Relay. Enter an API key name (does not have to be anything specific) and

  • Really Simple Payments: Collecting PayPal payments

    Using Groundhogg's really simple payments (which is also included in the plus plan or above) now users will be able to collect payments using PayPal. With the plugin update, you can see a new section

  • ThriveCart Integration: Introduction

    The ThriveCart integration allows you to listen for requests from ThriveCart to start automation in Groundhogg! You will need the ThriveCart Groundhogg extension or need to have the pro plan (or

  • Cloudflare Compatibility

    If you are using Cloudflare, you must make several tweaks so that Groundhogg and other highly dynamic WordPress plugins work as expected. Set Max Browser Cache TTL The max TTL is, "the amount of time

  • AWS Integration: Setup

    AWS is a powerful service that allows you to send both email and SMS directly from your site. Our integration provides several useful features such as... Send emails through SES Send SMS through SNS

  • ZeroBounce: Introduction

    Delivering emails inside the client's primary inbox is a hard task as it relies upon various elements, including maintaining a good server reputation and you can use ZeroBounce to help you.

  • Twilio Integration: Getting started with WhatsApp

    We are pleased to now offer an integration with the WhatsApp Business API via Twilio! This new integration allows limited 2-way communication with your customers via the popular chat app. Getting

  • Having trouble activating a license or installing an extension? It's not just you

    If you try to activate a Groundhogg license or install an extension through the Groundhogg helper, you may get an error message saying “cURL error 60: SSL certificate problem: certificate has

  • Caching Compatibility

    If you have a caching plugin (please only use one at a time) or any sort of system caching on your website or may notice Groundhogg not quite working as well and as quickly as you had hoped. There

  • Introduction to field mapping

    The field mapping API allows you to map fields between your product and ours and generate or update contact records without touching the database. To retrieve all the fields which can be mapped by

  • Why are tag and email dropdowns not loading?

    If you have just installed Groundhogg and you are unable to select tags or emails from dropdowns it may be because there is an issue with the REST API on your site. This generally happens because of

  • Trigger when Tags are changed, any tags, not one specific tag

    Scenario: Create a benchmark that triggers a funnel when tags are changed, any tags, not one specific tag. Using the Plugin API Benchmark. You will need to add this snippet of code to either your

  • Adding custom tabs and fields to the contact screen

    Custom tabs and fields can be added to the contact screen using the plugins API and the contact meta DB. You can see and read how on our Github or using the same code below. <?php class My_Custom_Tab

  • Third Party Integrations

    Groundhogg works with many third-party integrations* that can expand the functionality. AutomatorWP Samples Flowmattic Provides triggers and actions Hyperise Connect Groundhogg to Hyperise Pabbly

  • Settings

    Groundhogg has a "settings" tab located at Groundhogg > Settings The Settings page by default comes with eight tabs( General, Compliance, Email, Tags, API, Integrations, Misc, Licenses) Additional

  • SMS77 Integration: Introduction

    Groundhogg focuses on both SMS and email marketing. The Groundhogg SMS77 add-on is a plugin that lets you send messages using SMS77.io services. This documentation will help you to set up your

  • Adding a tag on an action

    One way to trigger custom events from other plugins in the funnel builder is to add a tag whenever an action is completed. This acts as an alternative to creating a custom benchmark. The Plugins API

  • Email Threading

    Email threading is a feature in email clients and services that organizes email messages into a single, coherent conversation. It aims to streamline the viewing and management of email chains by

  • Booking Calendar: How to Sync Google Calendar

    Please follow the step below to configure two-way sync with Google Calendar. Navigate to the calendar you want to sync, then go Integration, then click connect to another Google account. After you

  • How Fast Are My Emails Sent?

    If you are concerned about the speed of your emails sending to your customer the best way to put you at ease is to know the facts. Let's talk about how emails are sent! What's the event queue? You

  • How the List-Unsubscribe header works

    You may be here because you heard that GMail is now enforcing best practices for bulk senders, including adding the List-Unsubscribe header to your emails. Since Groundhogg always follows best

  • Advanced Features: Introduction To Webhooks

    Webhooks is included in the basic plan of Groundhogg and you will need to install the advanced features plugin to use webhook's. Groundhogg provides webhooks that you can use to communicate with