Introduction

Welcome to the documentation for Gravity Forms Send to API — an add-on that forwards your Gravity Forms entries to virtually any external REST API.

What it does

Gravity Forms ships with add-ons for popular services, but plenty of tools don't have one. Almost all of them, however, expose an API. Send to API lets you connect a form to any of those APIs without writing code: when an entry is submitted, the add-on builds a request from your form data and sends it to the endpoint you configure.

A few common uses:

• Create a contact or lead in a CRM
• Subscribe a user to an email or marketing platform
• Register a signup in an internal or third-party system
• Trigger a webhook or automation

How it works

Everything is configured through feeds. A feed is a rule you attach to a form that says "when an entry comes in, send this request to that API." You can add as many feeds to a form as you like, so a single submission can reach multiple endpoints.

Each feed lets you control:

• Endpoint & method — the URL to send to, using POST, PUT, PATCH, DELETE or GET.
• Authentication — Bearer token, Basic auth, OAuth 2 (password or client credentials), a custom header, or none at all.
• Field mapping — map form fields and custom values to the keys your API expects, with dot notation for nested objects and arrays (e.g. address.city or addresses.0.street).
• Response handling — store parts of the API response as merge tags to reuse in notifications and confirmations.
• Advanced options — request timeout, whether to wait for the response, and SSL verification.

Requirements

• PHP 8.0 or higher
• Gravity Forms 1.9.16 or higher

Get started

1. Install the plugin and activate your license so you keep receiving updates.
2. Create your first feed to map a form to an API endpoint.
3. Submit a test entry — and if you need to see exactly what was sent, open the debugging page.

Need something specific? Use the navigation to jump to feeds, merge tag manipulations, value casting, or resending entries.