Skip to main content
PATCH
Update webhook

Authorizations

Authorization
string
header
required

API key authentication. Generate an API key from your workspace settings.

Path Parameters

id
string<uuid>
required

The unique identifier of the webhook to update

Body

application/json
name
string

The name of the webhook

Minimum string length: 1
url
string<uri>

The URL that will receive webhook events

description
string

An optional description for the webhook

topics
enum<string>[]

The event types this webhook should listen to

Minimum array length: 1
Available options:
social_profile.connected,
social_profile.disconnected,
social_profile.reconnect_needed,
post.created,
post.scheduled,
post.rescheduled,
post.unscheduled,
post.published,
post.publish_failed,
post.archived,
post.permanently_deleted,
post.content.edited,
post.comment.created,
post.inline_comment.created,
post.approval.requested,
post.approval.approved,
campaign.approval.requested,
campaign.approval.approved,
invite.created,
invite.accepted
headers
object

Optional custom headers to include in webhook requests

Response

Webhook updated

A webhook configuration for receiving event notifications

id
string<uuid>
name
string
url
string<uri>
description
string | null
headers
object | null
topics
string[]
createdAt
string<date-time>
createdBy
object

User who created the webhook