Update a webhook
Hooks API

POSThttps://www.prayerletters.com/api/v1/hooks/:id

Change the target URL for a webhook subscription.

It isn't currently possible to change the event for a given webhook subscription. If you need to do this, create a new subscription and delete the old one.

URL Parameters

id
Example: h-###-####

Query Parameters

bearer_token

Notifications will include an Authorization header with this Bearer token. To remove an existing token, include this parameter with an empty string as its value. If not present, the existing value will be retained.

target

The URL that should be notified when the event occurs. The URL may contain query parameters, though a parameter will be overwritten if it has the same name as a query parameter provided by the webhook.

Response

200 OK

Response Body

hooks.hook.v1 Object

Example

{
   "event" : "...",
   "href" : "/api/v1/hooks/h-###-####",
   "id" : "h-###-####",
   "last_triggered" : "2024-12-21T13:39:39-05:00",
   "target" : "https://example.com/api/hooks?token=abc123"
}

Errors

400 hooks.invalid_target

The target must be an HTTP or HTTPS URL.

400 hooks.missing_target

The request didn't include a target.

API Overview
Contacts API
Files API
Hooks API
Orders API