Skip to main content
POST
Create an event destination

Authorizations

Authorization
string
header
required

Authorization: Bearer rbk_live_...

Redbark-Version
string
header
required

The API release your integration is built against, e.g. 2026-10-01.wattle. Required on every request.

Query Parameters

include[]

Related objects to expand inline. Repeat the parameter for more than one; see each resource for its includes.

Body

application/json
name
string
required
Required string length: 1 - 100
webhook_endpoint
object
required
enabled_events
string[]
required

Event types, families like "sync_run.", or ""

Minimum array length: 1
Minimum string length: 1
type
enum<string>
Available options:
webhook_endpoint
event_payload
enum<string>
Available options:
thin,
snapshot
metadata
object

Up to 50 string pairs. Set a key to null to unset it.

Response

Created

id
string
required
Example:

"ed_5Rt7Uv9wXy1zAb3cDe5fGh"

object
enum<string>
required
Available options:
event_destination
name
string
required
type
enum<string>
required
Available options:
webhook_endpoint
webhook_endpoint
object
required
enabled_events
string[]
required
event_payload
enum<string>
required
Available options:
thin,
snapshot
status
enum<string>
required
Available options:
enabled,
disabled
status_details
object | null
required
metadata
object | null
required

Up to 50 string pairs. Set a key to null in an update to unset it.

livemode
boolean
required
created
string<date-time>
required
Example:

"2026-08-21T09:30:00.000Z"

updated
string<date-time>
required
Example:

"2026-08-21T09:30:00.000Z"