Setup Your App
Overview
Before we start coding, we need to setup some resources in the HostedHooks dashboard. Login to your dashboard and let's walk through setting up your App.
1. Generate an App
Once in your dashboard, click Setup New App, fill out the App name and click Save.
2. Setup a Webhook Event
Next we will need to create a Webhook Event for your app that subscribers can subscribe to.
Go ahead and click Add More Events on your app page which will take you to a form to create a new Webhook Event.
Here you need to fill out:
- Event Type - This is the name of the event that you send webhooks for. We recommend a naming convention of
namespace.eventlikeuser.created. - Data Payload - This is a sample payload that your subscribers will be able to trigger during implementation to help them test their inbound webhooks integration.
3. Add a Test Subscriber
To test your HostedHooks integration we will want to see the end to end flow in action. In order to achieve this you will need to setup a test subscription which will simulate a real user that has subscribed to your webhooks.
Go ahead and click Add A Subscriber and enter a name for your subscriber. This will be a test so the name doesn't matter.
The view that you get redirected to is what your Subscriber's will see when they login.
Now that we have a subscriber we will need to setup an endpoint for them.
4. Create An Endpoint
Endpoints are the objects that hold all of the metadata around delivery, security and routing of your webhooks. In production you can either create these for users or give them access to create their own.
For this demo, we'll go ahead and create an endpoint for our test subscriber. Get started by clicking Setup New Endpoint.
Endpoint Data
Field
Description
URL
This URL is where we will send the webhook messages. If this URL does not return a 200 we will retry until it fails. In production this needs to be an endpoint on your subscriber's application. For testing we recommend you use a HookHelpers webhook sandbox URL.
Description
A text field describing what your endpoint is doing. This will help you organize your endpoints if you have multiple.
Status
Endpoints can be in an active (default) or inactive state. Inactive endpoints will not receive webhook attempts. If an endpoint fails to return a 200 after all attempted retries, then the endpoint will be moved into an inactive state and both the provider and subscriber will be notified via email.
Version
This is the version of the webhook message that this endpoint has subscribed to. As new versions get rolled out, this version maintains compatibility.
Once you have filled out all of the data hit save and your endpoint will have been created. Last up we need to subscribe our endpoint to webhook events.
5. Subscribe To Events
In order for your endpoint to start receiving messages, we need to tell it what events we want to subscribe to.
On your endpoint page, you will see a list of available events that you can subscriber to ( we created this one is Step 2) under the Subscribed Events. Go ahead and pick the event that we created and click Add Event. This will subscribe your endpoint to this event and will allow it to start receiving messages for the user.created event.
We are all done with the setup on the HostedHooks platform and now will move to building your API integration with HostedHooks.
Last modified 4mo ago