Skip to content
POLST Developer Docs

Update a webhook's url, events, description, or status.

PATCH
/brands/me/webhooks/{id}

Partial update. When events is provided it REPLACES the full list.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Webhook UUID.

Header Parameters

Section titled “Header Parameters ”
X-Polst-Idempotency-Key
required
string
>= 8 characters <= 255 characters

Idempotency key, 8–255 URL-safe chars.

Request Body required

Section titled “Request Body required ”
object
url
string format: uri
<= 2048 characters
description
Any of:
string
<= 255 characters
events
Array<string>
>= 1 items
Allowed values: polst.voted polst.closed campaign.step_completed campaign.completed brand.updated brand.theme_updated
status
string
Allowed values: ACTIVE DISABLED

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Webhook updated.

object
data
required
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
url
required
string format: uri
description
required
Any of:
string
events
required
Array<string>
Allowed values: polst.voted polst.closed campaign.step_completed campaign.completed brand.updated brand.theme_updated
status
required
string
Allowed values: ACTIVE DISABLED
createdAt
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
updatedAt
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/

400

Section titled “400 ”

Missing idempotency key.

401

Section titled “401 ”

Missing or invalid bearer token.

403

Section titled “403 ”

Bearer token lacks manage scope or brand context.

404

Section titled “404 ”

Webhook not found or not owned by the caller.

422

Section titled “422 ”

Request body failed validation.