Webhooks

Add Webhooks to your app with a simple integration

Introduction

Whether you have an API or not, Webhooks have become the status quo for asynchronous API events. They enable your users to receive updates on events from your platform and remove the need to poll your API for changes.

What You Will Build

In this guide, we'll walk you through how Webhooks work and we'll proof of concept a working demo of your app sending out webhooks using the HostedHooks API.

In this guide we'll show you how to:

  1. Add Webhooks to your app

  2. Setup your sender and recipient records

  3. Trigger a webhook from your app and watch it be received by your subscriber

Before Getting Started

To get the most of out of this guide, you'll need:

  • A HostedHooks developer account

API Object Definitions

Object

Definition

App

An App is an object that represents your application. It is also the object that will be sending webhooks and that your webhook recipients will subscribe to.

Endpoint

A endpoint is an object that represents your subscriber's webhook destination. It provides all the attributes around what events and where to send the webhooks.

Subscription

A subscription is the relationship between your webhook recipient's endpoint and your app.

Message

A message is an object that represents the API call from your App to HostedHooks. The contents of a message get converted into a Webhook attempt.

Last updated