curl --request GET \
--url https://api.platform.dakota.xyz/webhooks/targets/{webhook_target_id} \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.platform.dakota.xyz/webhooks/targets/{webhook_target_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.platform.dakota.xyz/webhooks/targets/{webhook_target_id}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.platform.dakota.xyz/webhooks/targets/{webhook_target_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"id": "1NFHrqBHb3cTfLVkFSGmHZqdDPi",
"url": "https://example.com/webhooks/receive",
"global": false,
"event_types": [
"api_key.created"
],
"time_last_healthy": 0,
"time_last_attempted": 0
}{
"type": "https://docs.dakota.xyz/api-reference/errors#authentication-error",
"title": "Unauthorized",
"status": 401,
"detail": "Unauthorized",
"instance": "https://api.platform.dakota.xyz/webhooks/targets/example-id",
"request_id": "req_01hzy6y7v8w9x0y1z2a3b4c5d6"
}{
"type": "https://docs.dakota.xyz/api-reference/errors#forbidden",
"title": "Forbidden",
"status": 403,
"detail": "Forbidden",
"instance": "https://api.platform.dakota.xyz/webhooks/targets/example-id",
"request_id": "req_01hzy6y7v8w9x0y1z2a3b4c5d6"
}{
"type": "https://docs.dakota.xyz/api-reference/errors#not-found",
"title": "Webhook target not found",
"status": 404,
"detail": "Webhook target not found",
"instance": "https://api.platform.dakota.xyz/webhooks/targets/example-id",
"request_id": "req_01hzy6y7v8w9x0y1z2a3b4c5d6"
}Get a webhook target
Retrieve details of a specific webhook target
curl --request GET \
--url https://api.platform.dakota.xyz/webhooks/targets/{webhook_target_id} \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.platform.dakota.xyz/webhooks/targets/{webhook_target_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.platform.dakota.xyz/webhooks/targets/{webhook_target_id}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.platform.dakota.xyz/webhooks/targets/{webhook_target_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"id": "1NFHrqBHb3cTfLVkFSGmHZqdDPi",
"url": "https://example.com/webhooks/receive",
"global": false,
"event_types": [
"api_key.created"
],
"time_last_healthy": 0,
"time_last_attempted": 0
}{
"type": "https://docs.dakota.xyz/api-reference/errors#authentication-error",
"title": "Unauthorized",
"status": 401,
"detail": "Unauthorized",
"instance": "https://api.platform.dakota.xyz/webhooks/targets/example-id",
"request_id": "req_01hzy6y7v8w9x0y1z2a3b4c5d6"
}{
"type": "https://docs.dakota.xyz/api-reference/errors#forbidden",
"title": "Forbidden",
"status": 403,
"detail": "Forbidden",
"instance": "https://api.platform.dakota.xyz/webhooks/targets/example-id",
"request_id": "req_01hzy6y7v8w9x0y1z2a3b4c5d6"
}{
"type": "https://docs.dakota.xyz/api-reference/errors#not-found",
"title": "Webhook target not found",
"status": 404,
"detail": "Webhook target not found",
"instance": "https://api.platform.dakota.xyz/webhooks/targets/example-id",
"request_id": "req_01hzy6y7v8w9x0y1z2a3b4c5d6"
}Authorizations
Path Parameters
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.
27^[0-9A-Za-z]{27}$"1NFHrqBHb3cTfLVkFSGmHZqdDPi"
Response
Webhook target retrieved successfully
A webhook target for receiving outbound webhook events
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.
27^[0-9A-Za-z]{27}$"1NFHrqBHb3cTfLVkFSGmHZqdDPi"
The URL where webhook events will be sent
"https://example.com/webhooks/receive"
If true, this target will receive all event types
false
Unix timestamp when this target last received a successful delivery (defaults to creation time if never healthy)
Unix timestamp when a delivery to this target was last attempted (defaults to creation time if never attempted)
List of event types this target cares about (ignored if global is true)
Canonical outbound event type identifier.
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 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.
active, disabled "active"
Unix timestamp when the target was disabled; null while it is active.
Why the target was disabled; null while it is active.
consecutive_failures, manual 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.
0
Was this page helpful?

