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_...) · headerrequired

A TipPage API key, created in Dashboard → Settings → Developer.

Path parameters

endpointIdstringrequired

Webhook endpoint id (`we_...`).

Request body

requiredapplication/json

urlstring<uri>

descriptionstring | null

max length 200

eventsstring[]

is_activeboolean

Responses

200Updated.

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>

400Invalid URL or events.

errorstringrequired

Human-readable message.

codestring

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

401Missing or invalid API key (`missing_api_key` / `invalid_api_key`).

errorstringrequired

Human-readable message.

codestring

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

403The key lacks the required scope (`missing_scope`).

errorstringrequired

Human-readable message.

codestring

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

required_scopestring

404No such resource.

errorstringrequired

Human-readable message.

codestring

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

429Rate limit exceeded - check the `RateLimit-*` headers.

errorstring

Request

curl -X PATCH "https://api.tippage.com/v1/webhook-endpoints/string" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "http://example.com",
  "description": "string",
  "events": [
    "string"
  ],
  "is_active": true
}'

const response = await fetch("https://api.tippage.com/v1/webhook-endpoints/string", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "url": "http://example.com",
  "description": "string",
  "events": [
    "string"
  ],
  "is_active": true
})
});

import requests

response = requests.patch(
    "https://api.tippage.com/v1/webhook-endpoints/string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
  "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"
  }
}