Docs

Update a webhook endpoint

Preview· P9
PATCH
/webhook-endpoints/{whep_id}

Changes an endpoint's URL, description or event types, or disables and re-enables it. Send only the fields you want to change. Setting status to enabled on an endpoint that Agoo disabled after repeated failures turns deliveries back on for new events.

Scope: webhooks:manage · Plan: Growth, Pro and Enterprise in live mode; every plan in test mode.

Authorization

headerAuthorizationBearer <token>

Send Authorization: Bearer <token> on every request. The token is one of:

PrefixWhat it isWhere it may be used
agoo_sk_live_Secret key, live modeYour servers only
agoo_sk_test_Secret key, test modeYour servers only
agoo_pk_live_Publishable key, live modeBrowsers and apps: create pre-registrations and bookings, read public booking types (with their intake questions) and their free slots, read the visit types open for pre-registration with their public forms. Never lists people.
agoo_pk_test_Publishable key, test modeAs above, in test mode

Admins create keys in Console → Developers → API keys and choose each key's scopes. A key is shown once. Never put a secret key in a URL, a browser or a mobile app.

Scope: webhooks:manage

Path Parameters

whep_id*string

The webhook endpoint's ID.

Match^whep_[0-7][0-9a-hjkmnp-tv-z]{25}$
Example"whep_01m2jf0cg0ffyrmjbzsk9t0gtc"

Request Body

application/json
  1. body
Properties1 <= properties
url?string
Match^https://
Formaturi
Lengthlength <= 2048
description?|
Lengthlength <= 200
enabled_events?array<|>
Items1 <= items
status?WebhookEndpointStatus
Value in"enabled""disabled"

Response Body

The updated endpoint.

application/json
  1. response

A URL that receives signed events.

id*WebhookEndpointId

A webhook endpoint ID (TypeID with the whep prefix).

Match^whep_[0-7][0-9a-hjkmnp-tv-z]{25}$
Example"whep_01m2jf0cg0ffyrmjbzsk9t0gtc"
url*string
Formaturi
Example"https://hooks.voltabank.example/agoo"
description*|
Lengthlength <= 200
enabled_events*array<|>
status*WebhookEndpointStatus
Value in"enabled""disabled"
disabled_reason*|

failing if Agoo disabled it after 5 days of failed attempts, manual if someone disabled it.

Value in"failing""manual"null
created_at*string
Formatdate-time
updated_at*string
Formatdate-time
curl -X PATCH 'https://api.agoohq.com/v1/webhook-endpoints/whep_01m2jf0cg0ffyrmjbzsk9t0gtc' \  -H 'Content-Type: application/json' \  -d '{  "enabled_events": [    "visit.checked_in",    "visit.checked_out",    "delivery.received",    "delivery.collected"  ]}'
{  "id": "whep_01m2jf0cg0ffyrmjbzsk9t0gtc",  "url": "https://hooks.voltabank.example/agoo",  "description": "Front desk integration",  "enabled_events": [    "visit.checked_in",    "visit.checked_out",    "delivery.received",    "delivery.collected"  ],  "status": "enabled",  "disabled_reason": null,  "created_at": "2026-09-15T12:00:00Z",  "updated_at": "2026-10-14T09:45:00Z"}