Docs

Type a word or a question. Esc closes the search.

Sign in Start free

Update a webhook subscription

Replaces a webhook subscription's receiver URL, event types and active state.

PUT https://app.upfour.io/v1/webhook-subscriptions/{subscriptionID}
PUT https://app.upfour.io/v1/webhook-subscriptions/{subscriptionID}

A real request. Sending it changes data in your up4 account.

Authorization
AuthorizationA pls_ key. It stays in this browser tab. Needs webhook.write.
Path
Body
More fields1
active Defaults to true, also on update: a PUT without active switches a disabled subscription back on.

1 more field is only available in JSON.

Sent directly from your browser to https://app.upfour.io/v1. Mutating calls get an automatic Idempotency-Key when the field is empty.

Request
Responsenot sent yet
Fill in a key and press Send request (⌘↵).
The answer appears here.
scope webhook.write beta returns 200

Parameters

FieldTypeDescription
subscriptionID required uuid path parameter

Body

application/json required 3 fields

eventsstring[]required

Event types to deliver, at least one; blanks and duplicates are dropped. The service does not check the names, an event that is never published simply never arrives. Published: monitor.created, monitor.updated, monitor.deleted, monitor.status_changed, monitor.degraded_changed, monitor.unstable, monitors.bulk_updated, incident.opened, incident.acknowledged, incident.resolved, incident.reopened, incident.escalated, incident.propagated, incident.partially_recovered, heartbeat.missed, heartbeat.recovered, status_page.update_published, status_page.report_published, webhook.test.

urlstring (uri)required

http or https URL of the receiver. A host that resolves to a private or otherwise blocked address range is refused.

All other fields1 fields
activeboolean · nullable

Defaults to true, also on update: a PUT without active switches a disabled subscription back on.

Returns

A successful request returns 200 with application/json.

Response fields 1 top-level fields
FieldTypeDescription
data WebhookSubscription
WebhookSubscription · 10 fields
FieldTypeDescription
active boolean
created_at string (date-time)
events string[] · nullable
failure_count integer
id uuid
org_id uuid
updated_at string (date-time)
url string
disabled_at string (date-time) Set while the subscription is switched off, by active: false or by the delivery worker after repeated failures.
last_delivery_at string (date-time)

Errors

Only the errors this operation can return. Every error uses the same envelope.

Status Code Meaning
400 bad_request The request is malformed or fails validation.
403 permission_denied The credentials do not permit this action.

Every call can also return unauthorized (401), rate_limit_exceeded (429) or internal_error (500 / 502). See Responses and errors.