List Webhooks

GET/webhooks

Webhook data

For document_update events, the data posted to the webhook URL will be the same format as the response data returned by the GET /documents/{documentId} call.

For sender_update events, the data posted to the webhook URL will be the same format as the response data returned by the GET /individuals/{individual_id} or GET /companies/{company_id} call.

For transfer_update events, the data posted to the webhook URL will be the same format as the response data returned by the GET /transfers/{transferId} call.

For payment_update events, the data posted to the webhook URL will contain the payment status update details.

For entity_anonymisation_event events, the data posted to the webhook URL will contain the entity’s data-retention anonymisation status, sent both when it’s upcoming and once it’s completed.

Response

idstring<uuid>

Webhook Identifier

external_idstring

A unique id specified by API caller to avoid duplication API request

event_type"document_update" | "sender_update" | "transfer_update" | "payment_update" | "entity_anonymisation_event"

Specify which event this webhook URL will handle.

notification_urlstring<uri>

The URL to which event notification data will be POSTed.

public_keystring

The URL to which event notification data will be POSTed.

headersobject

Headers to be included in the notification request.

Show headers properties

keystring

Header name

valuestring

Header value

<?php $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, "https://api.uat.triple-a.io/api/fiat-payout/v1/webhooks"); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET"); curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer <token>"]); $response = curl_exec($ch); curl_close($ch);

package main import ( "fmt" "io" "net/http" ) func main() { req, _ := http.NewRequest("GET", "https://api.uat.triple-a.io/api/fiat-payout/v1/webhooks", nil) req.Header.Set("Authorization", "Bearer <token>") resp, err := http.DefaultClient.Do(req) if err != nil { panic(err) } defer resp.Body.Close() data, _ := io.ReadAll(resp.Body) fmt.Println(string(data)) }

HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://api.uat.triple-a.io/api/fiat-payout/v1/webhooks")) .header("Authorization", "Bearer <token>") .method("GET", HttpRequest.BodyPublishers.noBody()) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body());

require "net/http" require "uri" uri = URI("https://api.uat.triple-a.io/api/fiat-payout/v1/webhooks") http = Net::HTTP.new(uri.host, uri.port) http.use_ssl = uri.scheme == "https" request = Net::HTTP::Get.new(uri) request["Authorization"] = "Bearer <token>" response = http.request(request) puts response.body

[ { "id": "00000000-0000-0000-0000-000000000000", "external_id": "string", "event_type": "document_update", "notification_url": "string", "public_key": "string", "headers": { "key": "content-type", "value": "application/json" } } ]