Skip to main content
PUT
/
webhooks
/
configurations
/
{id}
Update webhook configuration
curl --request PUT \
  --url https://api-sandbox.orum.io/webhooks/configurations/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Orum-Version: <orum-version>' \
  --data '
{
  "event_types": [],
  "url": "<string>",
  "enabled": true
}
'
import requests

url = "https://api-sandbox.orum.io/webhooks/configurations/{id}"

payload = {
    "event_types": [],
    "url": "<string>",
    "enabled": True
}
headers = {
    "Orum-Version": "<orum-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'PUT',
  headers: {
    'Orum-Version': '<orum-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({event_types: [], url: '<string>', enabled: true})
};

fetch('https://api-sandbox.orum.io/webhooks/configurations/{id}', 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://api-sandbox.orum.io/webhooks/configurations/{id}",
  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([
    'event_types' => [
        
    ],
    'url' => '<string>',
    'enabled' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Orum-Version: <orum-version>"
  ],
]);

$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://api-sandbox.orum.io/webhooks/configurations/{id}"

	payload := strings.NewReader("{\n  \"event_types\": [],\n  \"url\": \"<string>\",\n  \"enabled\": true\n}")

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

	req.Header.Add("Orum-Version", "<orum-version>")
	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://api-sandbox.orum.io/webhooks/configurations/{id}")
  .header("Orum-Version", "<orum-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"event_types\": [],\n  \"url\": \"<string>\",\n  \"enabled\": true\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api-sandbox.orum.io/webhooks/configurations/{id}")

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

request = Net::HTTP::Put.new(url)
request["Orum-Version"] = '<orum-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"event_types\": [],\n  \"url\": \"<string>\",\n  \"enabled\": true\n}"

response = http.request(request)
puts response.read_body
{
  "webhook_configuration": {
    "id": "<string>",
    "enterprise_name": "<string>",
    "event_types": [],
    "enabled": true,
    "url": "<string>",
    "created_at": "<string>",
    "created_by": "<string>",
    "updated_at": "<string>",
    "updated_by": "<string>"
  }
}
{
  "error_code": "<string>",
  "message": "<string>",
  "details": {}
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

Orum-Version
enum<string>
required

Version of Deliver and Verify APIs. Use v2022-09-21.

Available options:
v2022-09-21

Path Parameters

id
string<uuid>
required

Orum generated unique id for the webhook resource you are updating.

Body

application/json
event_types
enum<string>[]
required

The types of events for which you would like to receive a webhook e.g. transfer_created. Use subscribe_all to receive webhooks for all events.

The type of event you want to invoke a webhook for.

Available options:
subscribe_all,
person_created,
person_verified,
person_rejected,
person_restricted,
person_unverified,
person_closed,
person_all,
business_created,
business_verified,
business_rejected,
business_restricted,
business_unverified,
business_closed,
business_all,
external_account_created,
external_account_verified,
external_account_rejected,
external_account_restricted,
external_account_unverified,
external_account_closed,
external_account_all,
transfer_updated,
transfer_all,
verify_account_updated,
subledger_all,
subledger_created,
book_transfer_all,
book_transfer_updated
url
string
required

The URL where you would like the webhook to be sent.

enabled
boolean
required

A boolean to determine whether the configuration is enabled. Acts as an on/off switch for that particular webhook.

Response

200 response.

webhook_configuration
WebhookConfiguration · object
required