Skip to main content
PATCH
https://apis.hopnow.io
/
v1
/
customers
/
{customer_id}
/
webhook-endpoints
/
{endpoint_id}
Update Webhook Endpoint
curl --request PATCH \
  --url https://apis.hopnow.io/v1/customers/{customer_id}/webhook-endpoints/{endpoint_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "events": [
    {}
  ],
  "description": "<string>"
}
'
{
  "id": "<string>",
  "object": "<string>",
  "url": "<string>",
  "events": [
    {}
  ],
  "is_active": true,
  "description": "<string>",
  "created": "<string>",
  "updated": "<string>",
  "last_used_at": "<string>"
}

Path Parameters

customer_id
string
required
The customer’s external ID (starts with cus_)
endpoint_id
string
required
The webhook endpoint’s external ID (starts with whep_)

Request Body

url
string
Updated webhook URL (must be HTTPS)
events
array
Updated list of event types to subscribe to
description
string
Updated description

Response

id
string
Webhook endpoint identifier (starts with whep_)
object
string
Always returns "webhook_endpoint"
url
string
The webhook URL
events
array
Array of subscribed event types
is_active
boolean
Whether the endpoint is active
description
string
The webhook description
created
string
ISO 8601 timestamp when created
updated
string
ISO 8601 timestamp when last updated
last_used_at
string
When the endpoint was last used

Response Example

{
  "id": "whep_1234567890abcdef",
  "object": "webhook_endpoint",
  "url": "https://api.mycompany.com/webhooks/hopnow",
  "events": ["payout.created", "payout.completed", "payout.failed"],
  "is_active": true,
  "description": "Updated production webhook",
  "created": "2024-01-01T00:00:00Z",
  "updated": "2024-01-16T10:00:00Z",
  "last_used_at": "2024-01-15T12:30:00Z"
}