🎉 Celebrate with 10% OFF on All Products! Use Code: GFEX10 Or Buy Any 2+ Items for 30% OFF with Code: GFEX30!

Gravity Forms Sleekplan Integration Add-on

Updated 8 min read Gravity Forms Integrations A–Z
On this page
  1. What you need
  2. Step 1: Save your API key (Forms, Settings, Sleekplan)
  3. Step 2: Add a feed (your form, Settings, Sleekplan)
  4. What happens for an entry
  5. Retries, and why a post is never sent twice
  6. Webhook (optional): status changes and team comments in the entry
  7. Merge tags
  8. Developer hooks
  9. Bulk actions
  10. Updating from version 1.0.0
  11. What the add-on does not do
  12. Troubleshooting

The Gravity Forms Sleekplan Add-On turns Gravity Forms entries into feedback posts on your Sleekplan board. For each matching entry a background job creates a post with the title, description, category and status you set in the feed, optionally on behalf of the visitor (the Sleekplan end-user is found by e-mail or created), and saves extra key and value pairs on the post. It connects with your own Sleekplan API key, so the posts appear in your own workspace and nothing passes through a GravityExtra server.

Important: this add-on needs a paid Sleekplan plan with API access (Starter or higher). Sleekplan’s free Indie plan does not include the REST API, so the add-on cannot work on it. The plan is bought from Sleekplan, not from GravityExtra.

What you need

  • WordPress 5.8 or newer, PHP 7.4 or newer, Gravity Forms 2.5 or newer.
  • A Sleekplan workspace on a plan that includes the REST API (Sleekplan lists the API from the Starter plan up; the free Indie plan does not include it). Sleekplan’s own terms apply to your account and your API key.
  • An API key: in Sleekplan open Settings, Developer and copy the key from the API section. The key has the permissions of the team member who owns it.
  • The id of the Sleekplan category (feedback type) the posts should go to. Every Sleekplan post needs one.
  • A Gravity Extra licence key (Forms, Settings, Sleekplan).

Step 1: Save your API key (Forms, Settings, Sleekplan)

  1. Activate your licence key.
  2. Paste the API key and click Save Settings. The key is stored encrypted with your site’s security keys and is never shown again. Leave the box empty on later saves to keep it, type a new one to replace it, or tick Remove the stored API key when saving. If you change the WordPress security keys (AUTH_KEY, SECURE_AUTH_KEY and their salts), enter the key again.
  3. Click Check the API key: the add-on reads one post from your workspace and creates nothing. If your plan does not include the API, the message says so.
  4. Click Show category and status ids: Sleekplan’s API has no list of categories, so the add-on reads your latest 100 posts and shows the category ids and status ids they use. It needs at least one post in your workspace (create one by hand in Sleekplan first if the workspace is new).

Sleekplan API key settings in Gravity Forms

Setting What it does
Daily cap of posts Stops creating posts for the rest of the day (UTC) once this many were created by all feeds. Empty or 0: no cap.
Sleekplan product id (optional) The numeric product_id Sleekplan puts in every webhook. If you enter it, webhook deliveries for another product are ignored.
Create a new webhook key when saving Replaces the secret key in the webhook address. The old address stops working.

Step 2: Add a feed (your form, Settings, Sleekplan)

Open a form, go to Settings, Sleekplan, add a feed and fill in:

Field What it does
Post title Required. Plain text, merge tags work, cut to 200 characters.
Post description (optional) Plain text or Markdown, merge tags work (for example {all_fields}). HTML is removed, because Sleekplan does not accept it in a post.
Category id Required. The id of the Sleekplan category, for example feature. Letters, numbers, dashes and underscores only.
Status id (optional) The status the post starts in. Empty: Sleekplan uses open.
Post on behalf of Nobody (the post belongs to the owner of the API key), or the person who filled in the form: the add-on searches your Sleekplan end-users for the same e-mail, uses that user, and creates the end-user only when there is none (with the full name when you map it). An existing end-user is never changed.
Post metadata (optional) Up to 20 key and value pairs saved on the post. A key is typed text (letters, numbers, dash, underscore, up to 40); a value is a field or typed text with merge tags. Empty values are skipped.
Condition Create the post only for entries that match (conditional logic).

Sleekplan feed: post title, description, category and status

The metadata table saves a typed key as key = gf_custom with the text in custom_key, and a typed value as value = gf_custom with the text in custom_value; the add-on reads both.

Sleekplan feed: post metadata and conditional logic

What happens for an entry

  1. The entry is saved and the feed checks its condition. The visitor sees the normal confirmation: the form never waits for Sleekplan and never shows a Sleekplan error.
  2. A background job builds the post, finds or creates the end-user (if the feed posts on behalf of the visitor) and sends one request that creates the post, then sets the metadata pairs.
  3. The entry gets a note with the post id, category, status and end-user, an entry page box, the merge tags below and the notification event Sleekplan: the post is created.

Sleekplan box on a Gravity Forms entry

Retries, and why a post is never sent twice

  • Temporary problems before the post exists (a rate limit, a 5xx answer to a read, no connection) are retried automatically after 1 minute, 5 minutes, 30 minutes, 2 hours and 12 hours (six attempts). A longer Retry-After from Sleekplan wins.
  • The request that creates a post is sent once. If the answer is lost (a timeout or a reset), or Sleekplan answers with a 5xx error, the post may or may not exist, so the add-on does not repeat it: the entry note says so, “Send to Sleekplan (skip finished)” skips the entry, and you decide: look in Sleekplan, and use “Send to Sleekplan again (creates another post)” if the post is missing.
  • Refusals (400, 401, 403, 404, an unknown category, a plan without API access) are final and the note gives Sleekplan’s own words.
  • If the post exists but setting its metadata fails temporarily, only the missing pairs are tried again; a second post is never made.
  • An end-user request that gets no answer is not repeated either; the next try finds that end-user by e-mail.

Webhook (optional): status changes and team comments in the entry

Sleekplan can call your site when something happens to a post. The add-on uses three events for posts it made: item.update (a status change), comment.create (a public comment written by a team member) and item.delete.

  1. Save the settings once: the add-on creates a secret key and shows the webhook address on the settings page (it ends in ?key=...; keep it private).
  2. In Sleekplan open Settings, Developer, Webhooks, add a webhook and paste that address. Your site must be reachable from the internet over HTTPS (Sleekplan does not deliver to local addresses and does not retry a failed delivery).

Sleekplan does not sign webhooks with a signature. Its documentation recommends a secret in the address, and that is what the add-on creates and checks. The add-on fails closed: with no key stored, a missing or wrong key, an unreadable body, a delivery older than an hour or one for another product, nothing is read or changed. The same delivery twice is applied once. Comments written by customers and internal team comments are ignored.

A status change adds an entry note, updates the status shown in the entry box and in {sleekplan_status}, and sends the notification event Sleekplan: the post status changed.

Merge tags

Use these in notifications, confirmations and feeds (each takes an optional _<feed id> suffix, for example {sleekplan_post_id_12}):

  • {sleekplan_post_id} – the Sleekplan post id
  • {sleekplan_status} – the status id Sleekplan last reported (or the one the post started in)
  • {sleekplan_user_id} – the end-user id the post was made for
  • {sleekplan_comment} – the last public team comment received by webhook
  • {sleekplan_job} – the add-on’s own job status: queued, sending, retrying, ok or fail

Developer hooks

  • gform_sleekplan_feedback_payload (filter): receives an array with post (title, type, description, status), author (email, name, or an empty array) and meta (key => value), plus the feed and the entry. Return the array, or anything else to cancel the post.
  • gform_sleekplan_post_feedback (action): fires after a post is created, with the post id, the entry, the feed, the form and the result.
  • gsp_failed (action): fires when no post could be made, with the entry, feed, form and reason.
  • gsp_status_changed (action): fires when the webhook reports a new status, with the new status, the previous one, the entry and the feed.
  • gsp_webhook_url (filter): the address of the webhook route, for sites whose public address differs from the site address.
add_filter( 'gform_sleekplan_feedback_payload', function ( $plan, $feed, $entry ) {
	$plan['meta']['entry'] = $entry['id'];
	return $plan;
}, 10, 3 );

Bulk actions

In the entry list, Send to Sleekplan (skip finished) queues entries that have no post yet (it skips finished entries, entries waiting for a retry and entries whose request got no answer), and Send to Sleekplan again (creates another post) makes a new post on purpose. Both work in groups of 5.

Updating from version 1.0.0

Install the new zip over the old plugin once, then activate your licence key. The API key you typed in 1.0.0 is kept and encrypted. Version 1.0.0 never made a valid call (it used an address and a request body that do not exist), so click Check the API key. Your feeds are kept, but 1.0.0 never asked for a category: open each feed and enter the category id before it can run. The 1.0.0 name field becomes the post title and the additional data text becomes the description.

What the add-on does not do

It does not create comments, votes, changelog entries, surveys, tags or documents, does not list your categories, does not update or delete posts, and does not change an existing end-user. Webhook events other than the three above are ignored.

Troubleshooting

Entry note says What to do
Sleekplan did not accept the API key Copy a current key from Settings, Developer in Sleekplan and save it again.
Your Sleekplan plan does not include this (upgrade_required) The REST API needs a paid Sleekplan plan; check your plan in Sleekplan Billing.
Category not found / refused the request as invalid Use “Show category and status ids” on the settings page and enter an id that exists.
may or may not have been created Look in Sleekplan. If the post is missing use “Send to Sleekplan again”.
daily cap reached Raise the cap, or use “Send to Sleekplan again” tomorrow.

Still need help?

Our support team answers tickets every day, usually within a few hours.

0
0
Your Cart
Your cart is emptyReturn to Shop
🔥 FREQUENTLY BOUGHT TOGETHER
Complete Combo & Save 40%!
ITEM IN YOUR CART
Gravity Forms Klaviyo Add-on
$39.00/yr
+
🎁 RECOMMENDED ADD-ON SAVE 40% OFF
Original Price: $39.00/yr
Bundle Special Price: $23.40/yr