hooks.v1 Object
Hooks API

Attributes

events
description

A brief description of the event that triggers the webhook.

url
A web page describing the webhook.
subscriptions
event

The name of webhook that this subscription follows.

href
Example: https://www.prayerletters.com/api/v1/hooks/h-###-####

The URL of this webhook subscription. To delete or make changes to the webhook, you would make a DELETE or POST call to this URL.

id
Example: h-###-####
last_triggered
Example: 2024-05-05T00:31:08-04:00

The last time this subscription received an event. This timestamp is set when the event is generated, not when the webhook target is successfully contacted.

target
Example: https://example.com/api/hooks?token=abc123

The URL to be notified when the requested event is triggered. It must be an HTTP or HTTPS address and may contain query parameters.

Example Object

{
   "events" : {
      "..." : {
         "description" : "...",
         "url" : "..."
      }
   },
   "subscriptions" : [
      {
         "event" : "...",
         "href" : "/api/v1/hooks/h-###-####",
         "id" : "h-###-####",
         "last_triggered" : "2024-05-05T00:31:08-04:00",
         "target" : "https://example.com/api/hooks?token=abc123"
      },
      {
         "event" : "...",
         "href" : "/api/v1/hooks/h-###-####",
         "id" : "h-###-####",
         "last_triggered" : "2024-05-05T00:31:08-04:00",
         "target" : "https://example.com/api/hooks?token=abc123"
      }
   ]
}
API Overview
Contacts API
Files API
Hooks API
Orders API