The Conventus API allows integration of the platform with various other systems including but not limited to identify providers, registration providers, learning management systems, and beyond.
\nAll requests are signed using HMAC Authentication, and included in the request as the Conventus-Signature header.
Example:
\nConventus-Signature: t=1234567890,v1=853104d29b3c525975315e8c1dedf4ba2991b14a63a8a7b8e6723001bc4d2108\n\nThe signature consists of two elements:
\n| Element | Description |
|---|---|
| t | timestamp - number of seconds passed since January 1 1970. |
| v1 | HMAC SHA-256 signature of the payload, signed by your API token. |
To validate your HMAC SHA-265 signing function, we provide the following sample inputs and outputs:
\n| Element | Value |
|---|---|
| payload | { \"realm\": \"example.conventus.live\", \"timestamp\": \"1234567890\", \"event\": \"registration.created\", \"data\": { \"sample_field\": \"sample_value\" } } |
| token | ildNXslVaKB3eCeV6KUTVazix60jPhbpQisdIUBkoGNLXZMmrqFdsrlKajPCKfz |
| expected signature output | 2c7b2b97c5dbe516b82ca9afc9b9f94494cfbba14e8ca4a8405919de1ed37d3d |
Please contact our support team at digital+api@inspiresolutions.com for assistance with this API.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authentication","slug":"authentication"},{"content":"Support","slug":"support"}],"owner":"3334895","collectionId":"c81bfbb0-9842-4cca-8bcc-5720a56c745e","publishedId":"Szzq3Zqh","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-01-13T15:04:10.000Z"},"item":[{"name":"v1","item":[],"id":"b2333afb-9a05-43aa-809b-420cdb96061b","description":"The current version of the API is v1.
\n","_postman_id":"b2333afb-9a05-43aa-809b-420cdb96061b"},{"name":"webhooks","event":[{"listen":"prerequest","script":{"id":"4adf2710-c510-4cda-8078-9a9851265db1","exec":["const crypto = require('crypto-js');\r","\r","var signing_secret = pm.collectionVariables.get(\"signing_secret\");\r","var payload = JSON.parse(pm.request.body.raw);\r","var timestamp = payload[\"timestamp\"]\r","\r","var hash = crypto.HmacSHA256(pm.request.body.raw, signing_secret)\r","var signature = crypto.enc.Hex.stringify(hash)\r","\r","pm.environment.set(\"request_timestamp\", timestamp);\r","pm.environment.set(\"request_signature\", signature);"],"type":"text/javascript","packages":{}}}],"id":"dee283f9-ba4a-4c50-9854-5047fb7838b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Conventus-Signature","value":"t={{request_timestamp}},v1={{request_signature}}","description":"See Authentication section for more details.
\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"realm\": \"digital-testsss.conventus.live\",\r\n \"timestamp\": \"1740168991\",\r\n \"event\": \"registration.created\",\r\n \"data\": {\r\n \"email\": \"test@example.com\",\r\n \"name\": \"Catthew M\",\r\n \"first_name\": \"Catt\",\r\n \"last_name\": \"M\",\r\n \"RegID\": \"654321\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.conventus.live/webhooks","description":"Webhooks permit other systems to push data to our platform in real time.
\n","urlObject":{"protocol":"https","path":["webhooks"],"host":["api","conventus","live"],"query":[],"variable":[]}},"response":[{"id":"7f08f071-adbe-4fe0-84f6-f9ab6ca17aa9","name":"Authorized Query","originalRequest":{"method":"POST","header":[{"description":"See Authentication section for more details.","key":"Conventus-Signature","type":"text","value":"t=1234567890,v1=2d0f3ae5683cb4d74d4d212d0108ec6cb62612a97e2124453c6a96d5b40088df"},{"key":"Content-Type","name":"Content-Type","value":"text/plain","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"realm\": \"example.conventus.live\",\r\n \"timestamp\": \"1234567890\",\r\n \"event\": \"registration.created\",\r\n \"data\": {\r\n \"prefix\": \"Mr.\",\r\n \"first_name\": \"John\",\r\n \"last_name\": \"Doe\",\r\n \"affiliation\": \"ACME Ltd\",\r\n \"email\": \"jdoe@example.com\",\r\n \"registered_sessions\": [\r\n \"INT101\",\r\n \"APL223\"\r\n ]\r\n }\r\n}","options":{"raw":{"language":"text"}}},"url":"https://api.conventus.live/webhooks"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[],"cookie":[],"responseTime":null,"body":""},{"id":"2d16b602-322c-4f36-aaef-7e700963c79e","name":"Unauthorized Query","originalRequest":{"method":"POST","header":[{"description":"See Authentication section for more details.","key":"Conventus-Signature","type":"text","value":"t=BAD,v1=SIGNATURE"},{"key":"Content-Type","name":"Content-Type","value":"text/plain","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"realm\": \"example.conventus.live\",\r\n \"timestamp\": \"1234567890\",\r\n \"event\": \"registration.created\",\r\n \"data\": {\r\n \"prefix\": \"Mr.\",\r\n \"first_name\": \"John\",\r\n \"last_name\": \"Doe\",\r\n \"affiliation\": \"ACME Ltd\",\r\n \"email\": \"jdoe@example.com\",\r\n \"registered_sessions\": [\r\n \"type_as_string\",\r\n \"additional_type_as_string-optional\"\r\n ]\r\n }\r\n}","options":{"raw":{"language":"text"}}},"url":"https://api.conventus.live/webhooks"},"status":"Unauthorized","code":401,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"dee283f9-ba4a-4c50-9854-5047fb7838b4"}],"event":[{"listen":"prerequest","script":{"id":"3796b7a3-af2f-4ca8-9c50-104afecceaa7","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"5f129965-06be-4ce2-be1e-18f4e660f7c5","type":"text/javascript","packages":{},"exec":[""]}}],"variable":[{"key":"signing_secret","value":"323ea8ec468b7854604018dc80caf1fce534b538b6b323f39599c02b18a64a43","type":"string"}]}