Webhooks
Create webhook (REST)
3 min
{ "tab" "examples", "url" "https //api brella io/api/integration/organizations/{organizationid}/events/{eventid}/webhooks", "name" "create new webhook", "method" "post", "request" { "pathparameters" \[ { "kind" "required", "name" "{organizationid}", "type" "number", "children" \[], "description" "the id of the brella organization you are trying to retrieve data from" }, { "kind" "required", "name" "{eventid}", "type" "number", "children" \[], "description" "the id of the brella event you are trying to retrieve data from" } ], "queryparameters" \[], "headerparameters" \[ { "kind" "required", "name" "brella api access token", "type" "string", "children" \[], "description" "your unique brella api key" }, { "kind" "required", "name" "accept", "type" "string", "children" \[], "description" "application/vnd brella v4+json" }, { "kind" "required", "name" "content type", "type" "string", "children" \[], "description" "application/json" } ], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "psobomoj9uo00ibrqhmgp", "code" "{\n \\"data\\" {\n \\"id\\" \\"42\\",\n \\"type\\" \\"webhook\\",\n \\"attributes\\" {\n \\"name\\" \\"testing hook for attendee updates\\",\n \\"enabled\\" true,\n \\"request url\\" \\"https //hooks tester com/hooks/catch/123456/abacustest/\\",\n \\"request method\\" \\"post\\",\n \\"created at\\" \\"2023 04 11t20 03 49 247z\\",\n \\"updated at\\" \\"2023 04 11t20 03 49 247z\\",\n \\"webhookable type\\" \\"event\\",\n \\"webhookable id\\" 0117,\n \\"trigger item\\" \\"attendee\\",\n \\"trigger action\\" \\"updated\\"\n }\n }\n}", "language" "200", "customlabel" "" } ], "selectedlanguageid" "psobomoj9uo00ibrqhmgp" }, "examples" { "languages" \[ { "id" "crajpoumtvuqzjful oz", "code" "curl location g request post 'https //api brella io/api/integration/organizations/{organizationid}/events/{eventid}/webhooks' \\\\\n header 'brella api access token string' \\\\\n header 'accept application/vnd brella v4+json' \\\\\n header 'content type application/json'\\\\\n data '{ \n \\"webhook\\" { \n \\"name\\" \\"{{webhook name}\\", \n \\"trigger item\\" \\"{{trigger name}}}\\", \n \\"trigger action\\" \\"{{trigger action}}\\", \n \\"request url\\" \\"{{target url to send payload}}\\", \n \\"request method\\" \\"post\\" \n }\n }\n\n\n\n\n\n\n\n\n\n\n\n\n\n'\n\n\n\n\n\n\n\n\n\n\n\n\n\n'", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "crajpoumtvuqzjful oz" }, "description" "create a new webhook in an event", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } request body 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