Skip to content
TipPage Docs
Esc
↑↓navigate↵open⌘Jpreview

Update an endpoint

Any subset of url / description / events / is_active. Re-enabling a disabled endpoint clears its failure state. Requires webhooks:manage.

PATCH/webhook-endpoints/{endpointId}
Authorization
AuthorizationBearer token (tp_live_... or tpat_...) · headerrequired

A TipPage API key (tp_live_..., created in Dashboard → Settings → Developer) or an OAuth 2.0 access token (tpat_..., see the OAuth guide). Both carry the same scopes and are accepted on every endpoint.

Path parameters
endpointIdstringrequired

Webhook endpoint id (we_...).

Request body
requiredapplication/json
urlstring<uri>
descriptionstring | null
max length 200
eventsstring[]
is_activeboolean
Responses
200

Updated.

endpointWebhookEndpoint
Show properties
idstring
urlstring<uri>
descriptionstring | null
eventsstring[]

Subscribed event types, or ["*"] for everything.

is_activeboolean
disabled_reasonstring | null

Set when the endpoint was auto-disabled after repeated failures.

consecutive_failuresinteger

Deliveries that exhausted every retry since the last success.

last_success_atstring<date-time> | null
last_failure_atstring<date-time> | null
created_atstring<date-time>
400

Invalid URL or events.

errorstringrequired

Human-readable message.

codestring

Machine-readable code (e.g. missing_scope, not_in_queue).

401

Missing or invalid credential (missing_api_key / invalid_api_key, or invalid_token for an expired/revoked OAuth access token).

errorstringrequired

Human-readable message.

codestring

Machine-readable code (e.g. missing_scope, not_in_queue).

403

The key lacks the required scope (missing_scope).

errorstringrequired

Human-readable message.

codestring

Machine-readable code (e.g. missing_scope, not_in_queue).

required_scopestring
404

No such resource.

errorstringrequired

Human-readable message.

codestring

Machine-readable code (e.g. missing_scope, not_in_queue).

429

Rate limit exceeded - check the RateLimit-* headers.

errorstring
Try it
Server
Authorization
Parameters
Bodyapplication/json
Request
curl -X PATCH 'https://api.tippage.com/v1/webhook-endpoints/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "http://example.com",
  "description": "string",
  "events": [
    "string"
  ],
  "is_active": true
}'
Response
{
  "endpoint": {
    "id": "we_1a2b3c4d5e6f",
    "url": "http://example.com",
    "description": "string",
    "events": [
      "string"
    ],
    "is_active": true,
    "disabled_reason": "string",
    "consecutive_failures": 0,
    "last_success_at": "2019-08-24T14:15:22Z",
    "last_failure_at": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z"
  }
}