Skip to content

Webhook object specification

The webhook object allows you to modify or create webhook messages via our messaging endpoints.

1
2
3
4
5
6
7
{
  "url": (required, string),
  "request_method": (required, string) one of "POST", "PUT", "DELETE", or "GET",
  "request_headers": (optional, Hash) key-value pairs to use as request headers,
  "body": (optional, string) if you want to include a JSON object, make sure to escape quotes and backslashes,
  "message_variation_id": (optional, string) used when providing a campaign_id to specify which message variation this message should be tracked under
}

As a best practice, Braze recommends that you supply an explicit value for Content-Type in the request_headers field to ensure consistent and predictable behavior, as senders and servers may change over time. If a value is not specified for the Content-Type header, one will be inferred from the request body.

WAS THIS PAGE HELPFUL?
New Stuff!