Skip to main content
GET
Get a webhook target

Authorizations

x-api-key
string
header
required

Path Parameters

webhook_target_id
string
required

Unique identifier (ksuid) of the webhook target KSUID is a 27-character globally unique ID that combines a timestamp with a random component. Used for all entity identifiers in the Dakota platform.

Required string length: 27
Pattern: ^[0-9A-Za-z]{27}$
Example:

"1NFHrqBHb3cTfLVkFSGmHZqdDPi"

Response

Webhook target retrieved successfully

A webhook target for receiving outbound webhook events

id
string
required

KSUID is a 27-character globally unique ID that combines a timestamp with a random component. Used for all entity identifiers in the Dakota platform.

Required string length: 27
Pattern: ^[0-9A-Za-z]{27}$
Example:

"1NFHrqBHb3cTfLVkFSGmHZqdDPi"

url
string<uri>
required

The URL where webhook events will be sent

Example:

"https://example.com/webhooks/receive"

global
boolean
required

If true, this target will receive all event types

Example:

false

time_last_healthy
integer
required

Unix timestamp when this target last received a successful delivery (defaults to creation time if never healthy)

time_last_attempted
integer
required

Unix timestamp when a delivery to this target was last attempted (defaults to creation time if never attempted)

event_types
enum<string>[]

List of event types this target cares about (ignored if global is true)

Canonical outbound event type identifier.

Available options:
user.created,
user.updated,
user.deleted,
api_key.created,
api_key.updated,
api_key.deleted,
customer.created,
customer.updated,
customer.kyb_link.created,
customer.kyb_link.updated,
customer.kyb_status.created,
customer.kyb_status.updated,
customer.kyb_application.submitted,
customer.capability_status.updated,
customer.rfi.requested,
customer.rfi.responded,
customer.application.withdrawn,
customer.application.imported,
auto_account.created,
auto_account.updated,
auto_account.deleted,
transaction.auto.created,
transaction.auto.updated,
transaction.one_off.created,
transaction.one_off.updated,
recipient.created,
recipient.updated,
recipient.deleted,
destination.created,
destination.deleted,
target.created,
target.updated,
target.deleted,
exception.created,
exception.cleared,
wallet.created,
wallet.updated,
wallet.signer_group.created,
wallet.signer_group.updated,
wallet.policy.created,
wallet.policy.updated,
wallet.transaction.created,
wallet.transaction.updated,
wallet.deposit,
rd_payout_destination.updated,
deployment_payout_destination.updated,
fee_payout_destination.updated,
fee_payout_destination.deleted,
scheduled_payment.failed,
cardholder.created,
cardholder.updated,
cardholder.information_requested,
card.created,
card.updated,
card_transaction.created,
card_transaction.updated,
wallet.card_enablement.completed,
deposit.held,
deposit.returned,
account_verification.received,
account_verification.returned
status
enum<string>

active targets receive deliveries. disabled targets receive none. You disable a target yourself (disabled_reason: manual). In sandbox only, Dakota also disables a target after at least 20 consecutive failed deliveries spanning 48 hours with no 2xx in between (disabled_reason: consecutive_failures); production targets are never disabled automatically. Deliveries queued for a disabled target are kept and are sent once you re-enable it with PATCH and "enabled": true.

Available options:
active,
disabled
Example:

"active"

disabled_at
integer | null

Unix timestamp when the target was disabled; null while it is active.

disabled_reason
enum<string> | null

Why the target was disabled; null while it is active.

Available options:
consecutive_failures,
manual
consecutive_failures
integer

Failed deliveries to this target since its last 2xx response. After 5, deliveries to the target pause briefly (30 seconds, doubling up to 5 minutes) and resume with a single probe delivery; any 2xx resets the count.

Example:

0