Webhooks
Update webhook (REST)
3min
Update an existing webhook in an event
PATCH
Request Params
Path Params
{organizationId}
required
Number
The id of the Brella organization you are trying to retrieve data from
{eventId}
required
Number
The id of the Brella event you are trying to retrieve data from
{webhookId}
required
Number
The id of the webhook you are trying to update
Header Parameters
Brella-API-Access-Token
required
String
Your unique Brella API key
Accept
required
String
application/vnd.brella.v4+json
Content-Type
required
String
application/json
REQUEST BODY
{
"webhook": {
"name": "{{webhook_name}",
"trigger_item": "{{trigger_name}}}",
"trigger_action": "{{trigger_action}}",
"request_url": "{{target_url_to_send_payload}}",
"request_method": "post"
}
}
Required attributes:
- name String / a webhook name to help you identify the webhook (also visible in webhook logs)
- trigger_item String / the entity that triggers the webhook; see notes for supported values
- trigger_action String / the action that triggers the webhook; see notes for supported values
- request_url String / the URL to which Brella will POST the webhook payload
- request_method String / always leave as "post"
Notes:
01: Supported trigger_item values:
- "Speaker"
- "Sponsors::Sponsor"
- "Event::Invite"
- "Event::Ticket"
- "Attendee"
- "Event::TicketPurchase"
02: Supported trigger_action values:
- created
- updated
- deleted
Updated 13 Apr 2023
Did this page help you?