Skip to content

Steady

With Steady modules in Ibexa Connect, you can:

  • retrieve publication and list plans

  • list newsletter subscribers, list and cancel subscriptions

To get started with Steady, create an account at steadyhq.com

Connect Steady to Ibexa Connect

To connect Steady app, you need to obtain the API Key and insert it in your Steady app module scenario.

  1. Log in to your Steady account.

  2. Click Settings > Integrations > API. Copy the API key to a safe place.

    Steady_2.png

  3. Log in to your Ibexa Connect account, insert a Steady module in your scenario, and click the Add button next to the Connection field.

    Steady_1.gif

  4. In the Connection name field, enter a name for the connection.

  5. In the API key field, enter the details copied in step 2, and click Save.

You have successfully connected the Steady app and can now build scenarios.

Publication

You can retrieve publication and list plans using the following modules.

Get a Publication

Returns info about the publication associated with the API key.

List Plans

Returns an array with all plans of the publication.

Limit Set the maximum number of plans Ibexa Connect will return during one execution cycle. The default value is 10.

Subscriptions

You can list newsletter subscribers, list, and cancel subscriptions using the following modules.

List Newsletter Subscribers

Returns an array with all current newsletter subscribers of the publication.

Limit Set the maximum number of newsletter subscribers Ibexa Connect will return during one execution cycle. The default value is 10.

List Subscriptions

Returns an array with all current subscriptions of the publication.

Limit Set the maximum number of subscriptions Ibexa Connect will return during one execution cycle. The default value is 10.

Cancel a Subscription

Cancels a subscription respecting the end of the current term.

Subscription ID Select or map the Subscription ID you want to cancel.

Other

You can call APIs using the following module.

Make an API Call

Performs an arbitrary authorized API call.

Note

For the list of available endpoints, refer to the Steady API documentation.

URL

Enter a path relative to https://steadyhq.com/api/. For example, /v1/publication.

Method

GET

to retrieve information for an entry.

POST

to create a new entry.

PUT

to update/replace an existing entry.

PATCH

to make a partial entry update.

DELETE

to delete an entry.

Headers

Enter the desired request headers. You don't have to add authorization headers; we already did that for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.

Example of use - Get Plans

The following API call returns plans from your account.

URL: /v1/plans

Method: GET

Matches of the search can be found in the module's Output under Bundle > Body > data.

steady-3.png

In our example 1 plan details were returned:

stady-4.png