Skip to main content
PUT

Update Webhook

Changes an endpoint. Fields you leave out stay as they are. The signing secret does not change.

Request

integer
required
The ID of the endpoint
string
Display name of the endpoint
string
A public https address
array
Event keys the endpoint gets
array
Only send events about these social accounts. Send null or an empty array for all accounts.
array
Other workspaces whose events it also gets, or ["*"]. Send null to limit it to its own workspace.
boolean
Turn the endpoint on or off. Turning it on clears failing_since and disabled_reason.

Response

The updated endpoint object.
integer
Unique identifier of the endpoint
string
Display name of the endpoint
string
The https address that receives the events. An address can carry a token, so it is shown in full only when the key’s owner may edit the endpoint (notifications edit in its workspace, and in every workspace it covers). Otherwise it is cut to the scheme and host, such as https://example.com/….
boolean
true when url was cut because the key’s owner may not edit the endpoint
string
The last four characters of the signing secret. The API returns the full secret only when you create the endpoint; the app can show it again.
array
Event keys the endpoint gets
array
Social account ids the endpoint is limited to, or null for all accounts
array
Other workspaces whose events it also gets (["*"] for every workspace the creator owns), or null
boolean
Whether the endpoint is on. PostSyncer turns an endpoint off after it has been failing for 3 days.
string
When the endpoint started failing, or null
string
Why PostSyncer turned the endpoint off, or null
object
Deliveries over the last 7 days: sent, failed and daily, seven entries with the oldest first
string
When the latest delivery was made, or null
Needs the webhooks:update permission. Errors are the same as Create webhook, plus 404 when the endpoint does not exist or is in a workspace you cannot reach.