Webhooks

enable real time, event driven notifications to keep your organisation aware of all the changes happening within the ecosystem remain synchronized and informed about critical updates, such as changes to organizations, apis, certifications, and roles, without needing to constantly poll for information webhooks provide organizations with real time updates about ecosystem changes, ensuring they stay informed and responsive by automating notifications, webhooks eliminate the need for manual monitoring, significantly improving operational efficiency additionally, they offer integration flexibility, allowing organizations to adapt their systems dynamically to ecosystem updates and maintain seamless interaction with other participants you can subscribe an application or an authorization server to notifications from raidiam to learn how to subscribe to events happening in your ecosystem, see the subscribe to events docid\ z4tt0udyyaweyt1zue1bo article list of events that trigger a webhook certain actions may result in multiple notifications being sent through the webhook for instance, suspending an application not only suspends the application itself but also disables any certificates and keys issued for it consequently, separate notifications are sent for each of these events, detailing the disabling of each certificate and key individually creation, update, or delete organisations notifications are triggered when an organisation is created, updated, or deleted in the directory this ensures that any changes to organisational details, such as name, contact information, or status, are immediately communicated to relevant systems authorization server changes to an organisation’s authorization server configuration—such as adding or removing an instance—are communicated through webhooks domain claims notifications are sent when the domain claim for an organisation changes org auth domain role claim when an organization requests or updates its role authorization within a domain, webhooks notify relevant parties authorization server certification webhooks are triggered when an organisation’s authorization server gains or loses a certification these certifications verify compliance with ecosystem standards api resource changes to api resources, such as endpoints, versions, or supported operations, will trigger notifications api discovery endpoint webhooks notify changes related to endpoints used for api discovery contacts notifications are sent when the contact details of an organisation, such as administrative or technical contacts, are added, updated, or removed creation or update software authority claim webhooks notify when a software authority claim is created or updated creation or delete domain role authorization notifications are triggered when a role authorization within a domain is either granted or revoked for an organization creation or revocation organization or application/software statements certificate webhooks notify the issuance or revocation of digital certificates for organizations or their software these certificates are critical for secure communications and authentication within the ecosystem creation, update, delete, suspension, lifting of suspension, blocking, and unblocking application (software statement) a comprehensive set of webhook events is triggered for software statements these include creation, updates, deletions, suspension, lifting of suspension, blocking, and unblocking other organization’s terms and conditions webhooks are triggered when the process of signing terms and conditions begins notifications are also sent if there are changes in the status of the process, such as approval, rejection, or cancellation notification payloads the webhook payloads are constructed following a "general to event" structure for each triggered event, the entire structure of the changed resource is detailed within the response payload this design allows for the entire chain of context to be included in the payload, making it easier to interpret and act on notifications the event payload always consists of four fields apiresource the identifier of the resource for which the event happened updatetimestamp the time at which the event happened resourcepayload the payload (details) of the resource for which the event happened revision a versioning mechanism that tracks changes or updates to the resource being notified for most up to date resource payload samples, always refer to raidiam api documentation and the schema for the given resource example event payloads authorization server creation { "apiresource" "/organisations/79b34d52 125b 4e5a 8b69 db93e737aa78/authorisationservers/9f347e44 23a0 4e76 917f 87cd05fd9d2f", "updatetimestamp" "2024/12/12 17 32 57 57z", "resourcepayload" { "organisationdetails" { "organisationid" "79b34d52 125b 4e5a 8b69 db93e737aa78" }, "authorisationservers" \[ { "status" "active", "authorisationserverid" "9f347e44 23a0 4e76 917f 87cd05fd9d2f", "autoregistrationnotificationwebhook" "https //webhook site/7853d4fb 31c1 427e b8ec 9222bafce308", "autoregistrationsupported" true, "createdat" "2024 12 12t17 32 57z", "customerfriendlydescription" "sample server", "customerfriendlylogouri" "https //web sandbox raidiam io/logos/placeholder logo png", "customerfriendlyname" "east credit union sample authorization server", "developerportaluri" "https //east credit union com/devs/", "issuer" "https //auth sandbox raidiam io", "openiddiscoverydocument" "https //auth sandbox raidiam io/ well known/openid configuration", "organisationid" "79b34d52 125b 4e5a 8b69 db93e737aa78", "supportsciba" false, "supportsdcr" false, "supportsredirect" false, "termsofserviceuri" "https //east credit union com/tncs", "flags" \[ { "name" "a", "type" "authorisation server", "value" "a", "status" "active", "accesslevel" 0, "id" "774098dc 550c 4b5d b557 5cfd4350727e", "createdat" "2024 10 17t23 29 34z", "updatedat" "2024 10 17t23 29 34z" } ], "revision" 1084485 } ] } } organisation details update { "apiresource" "/organisations/79b34d52 125b 4e5a 8b69 db93e737aa78", "updatetimestamp" "2024/12/12 17 35 57 21z", "resourcepayload" { "organisationdetails" { "organisationid" "79b34d52 125b 4e5a 8b69 db93e737aa78", "status" "active", "organisationname" "east credit union", "createdon" "2024 03 06t11 57 06 407z", "legalentityname" "east credit union", "countryofregistration" "uk", "companyregister" "central bank", "size" "s3", "registrationnumber" "983456", "registeredname" "east credit union", "addressline1" "rua general pereira da silva 181", "city" "rio de janeiro", "postcode" "24220 030", "country" "br", "requiresparticipanttermsandconditionssigning" false, "logouri" "https //web sandbox raidiam io/logos/placeholder logo png", "flags" \[ { "name" "rpf 6211 data admin", "type" "organisation", "value" "rpf 6211 data admin", "status" "active", "accesslevel" 400, "id" "c9b243e6 a424 486b b3a2 beaaf2ba550d", "createdat" "2024 12 10t18 41 06z", "updatedat" "2024 12 10t18 41 06z" } ], "revision" 1084486 } } } application suspended { "apiresource" "/organisations/79b34d52 125b 4e5a 8b69 db93e737aa78/softwarestatements/81b9a364 05ba 4030 ac21 75a46d3fcdb3", "updatetimestamp" "2024/12/12 17 38 03 85z", "resourcepayload" { "organisationdetails" { "organisationid" "79b34d52 125b 4e5a 8b69 db93e737aa78" }, "softwarestatements" { "81b9a364 05ba 4030 ac21 75a46d3fcdb3" { "softwaredetails" { "status" "suspended", "clientid" "81b9a364 05ba 4030 ac21 75a46d3fcdb3", "clientname" "east credit union", "description" "asd", "environment" "sandbox", "organisationid" "79b34d52 125b 4e5a 8b69 db93e737aa78", "softwarestatementid" "81b9a364 05ba 4030 ac21 75a46d3fcdb3", "mode" "live", "rtsclientcreated" true, "policyuri" "https //www east credit union com/policy", "clienturi" "https //www east credit union com/", "logouri" "https //www east credit union com/logo png", "redirecturi" \[ "https //www east credit union com/app/" ], "termsofserviceuri" "https //www east credit union com/tc", "version" 1 30, "locked" true, "updatefailed" false, "additionalsoftwaremetadata" "{}", "openidfederationenabled" false, "requiresignedrequestobject" true, "idtokensignedresponsealgorithm" "ps256", "tokenendpointauthmethod" "tls client auth", "createdat" "2024 05 02t07 57 32z", "tlsclientcertificateboundaccesstokens" true, "revision" 1084487 } } } } }