Skip to main content
PATCH
Update a destination

Authorizations

Authorization
string
header
required

Your API key, created in Settings › API: Authorization: Bearer tikt_live_….

Path Parameters

id
string<uuid>
required

The destination's id.

Body

application/json
name
string

The destination's new name, 1 to 80 characters.

Required string length: 1 - 80
url
string

The https:// address TIKT sends events to. Public addresses only.

Required string length: 1 - 2048
all_events
boolean

true to receive every event, including types added later. false by default.

events
enum<string>[]

The event types to receive, when all_events is false. Empty: the destination only serves workflows.

Maximum array length: 32
Available options:
lead.created,
lead.rescored,
lead.engaged_again,
lead.status_changed,
list.lead_added,
list.lead_removed,
list.created,
list.renamed,
list.deleted,
post.discovered,
post.harvested,
post.harvest_paused,
post.harvest_resumed,
post.closed,
kol.added,
kol.ready,
kol.updated,
kol.paused,
kol.resumed,
kol.archived,
kol.restored,
kol.followers_recorded,
icp.updated,
blocklist.company_added,
blocklist.company_removed,
credits.low,
credits.exhausted,
billing.period_closed,
workspace.updated,
cycle.completed,
cycle.failed,
webhook.endpoint_disabled
format
enum<string>

single (one request per event, the default) or batch (up to 100 events per request).

Available options:
single,
batch
headers
object

Up to three headers of your own, {"name": "value"}, sent with every request. Given on an update, they replace the current ones.

enabled
boolean

false turns the destination off; true turns it back on.

Response

Success.

id
string
required
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
name
string
required
tool
string
required
url
string
required
all_events
boolean
required
events
string[]
required
format
string
required
status
string
required
disabled_reason
string | null
required
disabled_at
string | null
required
Pattern: ^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\dZ$
api_version
string
required
created_at
string
required
Pattern: ^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\dZ$
used_by_workflows
integer
required
slack
object
last_response_status
integer | null