Update a webhook endpoint
Changes the fields you send. Changing url cancels deliveries still waiting for the old URL. Send the endpoint's revision as If-Match to refuse the change if someone updated the endpoint since you read it (revision_mismatch).
Required scope: webhooks:write.
Errors
- 400:
invalid_content_type,invalid_json,invalid_webhook_url,request_body_too_large,unknown_event_type,unknown_field - 401:
authentication_required,invalid_api_key - 403:
api_access_disabled,insufficient_scope - 404:
webhook_endpoint_not_found - 412:
revision_mismatch - 422:
invalid_parameter - 429:
rate_limit_exceeded - 500:
api_error - 503:
maintenance_mode,service_unavailable
ApiKeyAuthorizationBearer <probb_live_<id>_<secret>>id*stringThe webhook endpoint's ID.
1 <= length <= 200application/json- body
url?stringWhere to send events: an HTTPS URL on port 443 on the public Internet, without credentials or a fragment. Addresses inside private networks are refused.
1 <= length <= 2048description?|A label for you. Send null to clear it.
events?array<>The event types to send, for example ["report.completed", "decision.updated"], or ["*"] for every current and future type. ping is not subscribable: it is sent only by the test endpoint.
1 <= items <= 100status?stringpaused stops sending; events that happen while paused are not sent later (read them from GET /v1/events). active resumes.
"active""paused"Success.
application/json- response
object*stringid*stringThe endpoint's ID.
url*stringThe HTTPS URL events are sent to.
description*|A label for you, shown in the app.
events*array<string>The event types sent to this endpoint, or ["*"] for every current and future type.
status*stringpaused endpoints receive nothing; events that happen meanwhile are not sent later, but stay in GET /v1/events.
"active""paused"revision*stringOpaque token that changes whenever the endpoint does. Send it as If-Match on PATCH to refuse the change if someone else got there first.
previousSecretExpiresAt*|While a rotated secret is still accepted, when the old one stops signing. Events are signed with both until then.
secretRotatedAt*|When the signing secret was last rotated, if ever.
createdAt*stringWhen the endpoint was created.
date-timeupdatedAt*stringWhen the endpoint last changed.
date-time# Set PROBB_URL and PROBB_API_KEY. Replace any *_VALUE placeholder and any example ID (such as job_example) with a real one.curl --fail-with-body -X PATCH "$PROBB_URL/api/v1/webhook-endpoints/ID_VALUE" \ -H "Authorization: Bearer $PROBB_API_KEY" \ -H 'Content-Type: application/json' \ --data-binary '{ "events": [ "*" ], "status": "active"}'{ "object": "webhook_endpoint", "id": "string", "url": "string", "description": "string", "events": [ "string" ], "status": "active", "revision": "string", "previousSecretExpiresAt": "2019-08-24T14:15:22Z", "secretRotatedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z"}