Hapio Logo

How to get started with Hapio

To help get you started, we’ve put together a short explanation to help you get started with Hapio.

Your first steps

It’s easy to start developing with Hapio.

  • Register account
  • Create project
  • Create API token

Register account

Head over to hapio.app/register to register your account by providing your name and email address. Your account is personal, and you can invite others to your projects as well as them inviting you to their projects.

Create project

Once you’ve entered the portal, you are ready to create your first project. Click on “Create your first project” on the dashboard, or click on “No project selected” in the menu and then “Create new project”. Enter the name of your project, for example the name of the business, and click “Create”.

Create API token

The only thing left to do before you can start using the API is to create your first API token. Click on “API Tokens” in the menu, and enter the name of your token and select the abilities you need for it. The generated API token will be shown only once, so be sure to save it to some secure location. Now that you have created your first token, you are ready to start sending requests to the API.

Additional steps

Invite team member

In the project settings, you can invite others to join your project by providing their email address. Once the team member has accepted the invitation by logging in or registering an account, they will have access to the project’s API tokens, API requests and webhooks.

Inspect API requests

You can view the full log of all API requests for your project. By clicking on a request, you can view details about the request, such as processing time and request and response headers and bodies. Note that API request and response bodies are cleared after 14 days, but all other information persists.

Create webhook

Webhooks allow you to react to events that happen within Hapio. Enter the name of your webhook, the URL that should be called, and the events that you are interested in. Hapio will now send webhook requests to the provided URL as soon as any of the chosen events happen. For each webhook, you can view the full log of webhook requests that has been sent for that particular webhook.

Just as with API requests, you can click on a request to view additional details about the request, such as the time taken for the request and request and response headers and bodies. Note that webhook request and response bodies are cleared after 14 days, but all other information persists.

Upgrade to a paid plan

If the limits of the free plan are not enough for you, you can upgrade your project to a paid plan by clicking on “Choose subscription plan” on the dashboard for the project. There are three different paid plans to choose from, and you can switch plans at any moment.