Hosted Hooks Developer Resources
  • Welcome To Our Developer Resources
  • Getting Started
    • What is HostedHooks
    • Quickstart
    • Email Parsing
      • Ingesting Emails
    • Webhooks
      • Setup Your App
      • Integrate With Your App
    • Tasks
      • Getting Started
  • Security
    • Our Policy
    • Security Features
      • Encryption
      • Webhook Signatures
  • Developer Resources
    • API Object Definitions
      • Organization
      • Apps
      • Subscription
      • Endpoint
      • Webhook Events
      • Messages
      • Webhook Attempts
    • Providers
      • Managing Replays
    • Subscribers
      • Subscription Management
      • Endpoint Management
    • Internal Webhooks
Powered by GitBook
On this page

Was this helpful?

  1. Developer Resources
  2. API Object Definitions

Endpoint

The details of what an Endpoint is and how it's used

PreviousSubscriptionNextWebhook Events

Last updated 4 years ago

Was this helpful?

What Are Endpoints?

An Endpoint is where your App's Subscribers will define where they want to receive the webhook messages.

The Endpoint has the following parameters:

  • URL

  • Description

  • Version

URL

This is a full URL with the protocol, domain and path (example below) to where your Subscriber wants to receive their webhook messages. 

https://hostedhooks.com/r/a2ad45asafa2asad998asf

Description

A way to organize your endpoints with a simple text description.

Version

This is a custom string that denotes what version of the webhook the specific Endpoint is configured for. This number allows the providers to upgrade webhook payloads without breaking the existing Endpoint implementations. Your subscribers will only be able to select from existing versions.