Create or update the transaction review config for an environment

Configures a webhook that is called before every transaction signing request. The webhook must respond with { "proceed": true } to allow signing, or { "proceed": false, "reason": "..." } to block it.

PUT /environments/{environmentId}/waas/transactionReviewConfig

Create or update the transaction review config for an environment

cURL

curl --request PUT \
  --url https://app.dynamicauth.com/api/v0/environments/{environmentId}/waas/transactionReviewConfig \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "webhookUrl": "<string>",
  "enabled": true,
  "webhookPublicKey": "<string>",
  "webhookSecret": "<string>",
  "webhookTimeoutMs": 15250
}
'

import requests

url = "https://app.dynamicauth.com/api/v0/environments/{environmentId}/waas/transactionReviewConfig"

payload = {
    "webhookUrl": "<string>",
    "enabled": True,
    "webhookPublicKey": "<string>",
    "webhookSecret": "<string>",
    "webhookTimeoutMs": 15250
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    webhookUrl: '<string>',
    enabled: true,
    webhookPublicKey: '<string>',
    webhookSecret: '<string>',
    webhookTimeoutMs: 15250
  })
};

fetch('https://app.dynamicauth.com/api/v0/environments/{environmentId}/waas/transactionReviewConfig', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.dynamicauth.com/api/v0/environments/{environmentId}/waas/transactionReviewConfig",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'webhookUrl' => '<string>',
    'enabled' => true,
    'webhookPublicKey' => '<string>',
    'webhookSecret' => '<string>',
    'webhookTimeoutMs' => 15250
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.dynamicauth.com/api/v0/environments/{environmentId}/waas/transactionReviewConfig"

	payload := strings.NewReader("{\n  \"webhookUrl\": \"<string>\",\n  \"enabled\": true,\n  \"webhookPublicKey\": \"<string>\",\n  \"webhookSecret\": \"<string>\",\n  \"webhookTimeoutMs\": 15250\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://app.dynamicauth.com/api/v0/environments/{environmentId}/waas/transactionReviewConfig")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"webhookUrl\": \"<string>\",\n  \"enabled\": true,\n  \"webhookPublicKey\": \"<string>\",\n  \"webhookSecret\": \"<string>\",\n  \"webhookTimeoutMs\": 15250\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.dynamicauth.com/api/v0/environments/{environmentId}/waas/transactionReviewConfig")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"webhookUrl\": \"<string>\",\n  \"enabled\": true,\n  \"webhookPublicKey\": \"<string>\",\n  \"webhookSecret\": \"<string>\",\n  \"webhookTimeoutMs\": 15250\n}"

response = http.request(request)
puts response.read_body

200

{
  "enabled": true,
  "environmentId": "95b11417-f18f-457f-8804-68e361f9164f",
  "webhookSecretSet": true,
  "webhookTimeoutMs": 123,
  "webhookUrl": "<string>",
  "webhookPublicKey": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "No jwt provided!"
}

{
  "error": "Access Forbidden"
}

{
  "error": "Internal Server Error"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

environmentId · string · required

ID of the environment

Required string length: 36

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

Body

application/json

webhookUrl · string<uri> · required

URL that receives transaction review requests before signing.

enabled · boolean

Whether transaction review is active. Defaults to true.

webhookFailurePolicy · enum<string>

Determines what happens when the review webhook is unreachable or times out. ALLOW proceeds with signing; DENY blocks the transaction. Defaults to DENY when omitted from a configuration request.

Available options: ALLOW, DENY

webhookPublicKey · string | null

Optional Ed25519 public key (PEM format) used to verify the response signature from the webhook. When configured, the webhook must include an x-dynamic-response-signature header containing a base64-encoded Ed25519 signature over the raw response body. Pass null to remove.

webhookSecret · string | null

Optional secret used to sign webhook requests via HMAC-SHA256. Sent as the x-dynamic-signature header. Pass null to remove.

webhookTimeoutMs · integer

Milliseconds to wait for a webhook response. Defaults to 5000.

Required range: 500 <= x <= 30000

Response

200

application/json

Transaction review config saved

enabled · boolean · required

environmentId · string · required

Required string length: 36

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

webhookFailurePolicy · enum<string> · required

Determines what happens when the review webhook is unreachable or times out. ALLOW proceeds with signing; DENY blocks the transaction. Defaults to DENY when omitted from a configuration request.

Available options: ALLOW, DENY

webhookSecretSet · boolean · required

True iff a webhook secret is stored. The secret itself is never returned.

webhookTimeoutMs · integer · required

webhookUrl · string<uri> · required

webhookPublicKey · string

Ed25519 public key (PEM format) configured for response signature verification, if any.