{ "info": { "_postman_id": "fc5a50b3-08e4-43bf-921c-ed002419f95e", "name": "OAuth 2.0 - ClaimCenter Accelerator Webhooks", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "15673074" }, "item": [ { "name": "Certified Accelerator", "item": [ { "name": "Opt-In Webhook", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"EVENT_ID\": 2,\n \"HTTP_POST_ADDRESS\": ,\n \"HEADERS\":{\n \"Authorization\": {\n \"type\": \"OaUth2\",\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"{{client_id}}\",\n \"client_secret\": \"{{client_secret}}\",\n \"token_url\": \"{{authTokenURL}}\"\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/webhooks/register", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", "register" ] }, "description": "

Subscribe to a webhook that will be called when the specified event in Hi Marley occurs.\nEach webhook has a potentially different required request body based on the functionality and configuration

View the different example request bodies below for different webhook subscriptions

Hi Marley Webhook Overview

\n" }, "response": [ { "name": "Webhook successfully registered", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"EVENT_ID\": 3,\n \"PGP_KEY\": \"BASE64_PGP_KEY_FOR_OPTIONAL_ENCRYPTION\",\n \"format\": \"${caseData.brand}/${primaryContact.first}-${primaryContact.last}/${partialId}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/webhooks/register", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", "register" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"REGISTERED_PAYLOAD\": {\n \"EVENT_ID\": -3838413,\n \"HTTP_POST_ADDRESS\": \"commodo cillum ullamco\",\n \"HEADERS\": [\n \"tempor consequat Ut\",\n \"pariatur anim consectetur et in\"\n ]\n },\n \"SUBSCRIPTION_ID\": \"11\",\n \"EVENT\": \"CLOSE_CASE\"\n}" }, { "name": "Standard Error from Marley.\nFormat is consistent for all failure status codes, even though documentation only shows 400 error code responses.\n", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"EVENT_ID\": 3,\n \"PGP_KEY\": \"BASE64_PGP_KEY_FOR_OPTIONAL_ENCRYPTION\",\n \"format\": \"${caseData.brand}/${primaryContact.first}-${primaryContact.last}/${partialId}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/webhooks/register", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", "register" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errors\": [\n {\n \"meta\": {},\n \"detail\": \"dolore mollit\",\n \"title\": \"elit sunt tempor do\",\n \"status\": \"officia irure\"\n },\n {\n \"meta\": {},\n \"detail\": \"cillum officia\",\n \"title\": \"in sunt\",\n \"status\": \"reprehenderit in in deserunt labore\"\n }\n ]\n}" } ] }, { "name": "Opt-Out Webhook", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"EVENT_ID\": 1,\n \"HTTP_POST_ADDRESS\": \"\",\n \"HEADERS\": {\n \"Authorization\": {\n \"type\": \"OaUth2\",\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"{{client_id}}\",\n \"client_secret\": \"{{client_secret}}\",\n \"token_url\": \"{{authTokenURL}}\"\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/webhooks/register", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", "register" ] }, "description": "

Subscribe to a webhook that will be called when the specified event in Hi Marley occurs.\nEach webhook has a potentially different required request body based on the functionality and configuration

View the different example request bodies below for different webhook subscriptions

Hi Marley Webhook Overview

\n" }, "response": [ { "name": "Webhook successfully registered", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"EVENT_ID\": 3,\n \"PGP_KEY\": \"BASE64_PGP_KEY_FOR_OPTIONAL_ENCRYPTION\",\n \"format\": \"${caseData.brand}/${primaryContact.first}-${primaryContact.last}/${partialId}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/webhooks/register", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", "register" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"REGISTERED_PAYLOAD\": {\n \"EVENT_ID\": -3838413,\n \"HTTP_POST_ADDRESS\": \"commodo cillum ullamco\",\n \"HEADERS\": [\n \"tempor consequat Ut\",\n \"pariatur anim consectetur et in\"\n ]\n },\n \"SUBSCRIPTION_ID\": \"11\",\n \"EVENT\": \"CLOSE_CASE\"\n}" }, { "name": "Standard Error from Marley.\nFormat is consistent for all failure status codes, even though documentation only shows 400 error code responses.\n", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"EVENT_ID\": 3,\n \"PGP_KEY\": \"BASE64_PGP_KEY_FOR_OPTIONAL_ENCRYPTION\",\n \"format\": \"${caseData.brand}/${primaryContact.first}-${primaryContact.last}/${partialId}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/webhooks/register", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", "register" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errors\": [\n {\n \"meta\": {},\n \"detail\": \"dolore mollit\",\n \"title\": \"elit sunt tempor do\",\n \"status\": \"officia irure\"\n },\n {\n \"meta\": {},\n \"detail\": \"cillum officia\",\n \"title\": \"in sunt\",\n \"status\": \"reprehenderit in in deserunt labore\"\n }\n ]\n}" } ] }, { "name": "Case Notes Webhook", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"EVENT_ID\": 16,\n \"HTTP_POST_ADDRESS\": ,\n \"HEADERS\": {\n \"Authorization\": {\n \"type\": \"OaUth2\",\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"{{client_id}}\",\n \"client_secret\": \"{{client_secret}}\",\n \"token_url\": \"{{authTokenURL}}\"\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/webhooks/register", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", "register" ] }, "description": "

Subscribe to a webhook that will be called when the specified event in Hi Marley occurs.\nEach webhook has a potentially different required request body based on the functionality and configuration

View the different example request bodies below for different webhook subscriptions

Hi Marley Webhook Overview

\n" }, "response": [ { "name": "Webhook successfully registered", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"EVENT_ID\": 3,\n \"PGP_KEY\": \"BASE64_PGP_KEY_FOR_OPTIONAL_ENCRYPTION\",\n \"format\": \"${caseData.brand}/${primaryContact.first}-${primaryContact.last}/${partialId}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/webhooks/register", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", "register" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"REGISTERED_PAYLOAD\": {\n \"EVENT_ID\": -3838413,\n \"HTTP_POST_ADDRESS\": \"commodo cillum ullamco\",\n \"HEADERS\": [\n \"tempor consequat Ut\",\n \"pariatur anim consectetur et in\"\n ]\n },\n \"SUBSCRIPTION_ID\": \"11\",\n \"EVENT\": \"CLOSE_CASE\"\n}" }, { "name": "Standard Error from Marley.\nFormat is consistent for all failure status codes, even though documentation only shows 400 error code responses.\n", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"EVENT_ID\": 3,\n \"PGP_KEY\": \"BASE64_PGP_KEY_FOR_OPTIONAL_ENCRYPTION\",\n \"format\": \"${caseData.brand}/${primaryContact.first}-${primaryContact.last}/${partialId}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/webhooks/register", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", "register" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errors\": [\n {\n \"meta\": {},\n \"detail\": \"dolore mollit\",\n \"title\": \"elit sunt tempor do\",\n \"status\": \"officia irure\"\n },\n {\n \"meta\": {},\n \"detail\": \"cillum officia\",\n \"title\": \"in sunt\",\n \"status\": \"reprehenderit in in deserunt labore\"\n }\n ]\n}" } ] }, { "name": "Message Webhook", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"EVENT_ID\": 14,\n \"HTTP_POST_ADDRESS\": ,\n \"HEADERS\": {\n \"Authorization\": {\n \"type\": \"OaUth2\",\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"{{client_id}}\",\n \"client_secret\": \"{{client_secret}}\",\n \"token_url\": \"{{authTokenURL}}\"\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/webhooks/register", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", "register" ] }, "description": "

Subscribe to a webhook that will be called when the specified event in Hi Marley occurs.\nEach webhook has a potentially different required request body based on the functionality and configuration

View the different example request bodies below for different webhook subscriptions

Hi Marley Webhook Overview

\n" }, "response": [ { "name": "Webhook successfully registered", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"EVENT_ID\": 3,\n \"PGP_KEY\": \"BASE64_PGP_KEY_FOR_OPTIONAL_ENCRYPTION\",\n \"format\": \"${caseData.brand}/${primaryContact.first}-${primaryContact.last}/${partialId}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/webhooks/register", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", "register" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"REGISTERED_PAYLOAD\": {\n \"EVENT_ID\": -3838413,\n \"HTTP_POST_ADDRESS\": \"commodo cillum ullamco\",\n \"HEADERS\": [\n \"tempor consequat Ut\",\n \"pariatur anim consectetur et in\"\n ]\n },\n \"SUBSCRIPTION_ID\": \"11\",\n \"EVENT\": \"CLOSE_CASE\"\n}" }, { "name": "Standard Error from Marley.\nFormat is consistent for all failure status codes, even though documentation only shows 400 error code responses.\n", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"EVENT_ID\": 3,\n \"PGP_KEY\": \"BASE64_PGP_KEY_FOR_OPTIONAL_ENCRYPTION\",\n \"format\": \"${caseData.brand}/${primaryContact.first}-${primaryContact.last}/${partialId}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/webhooks/register", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", "register" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errors\": [\n {\n \"meta\": {},\n \"detail\": \"dolore mollit\",\n \"title\": \"elit sunt tempor do\",\n \"status\": \"officia irure\"\n },\n {\n \"meta\": {},\n \"detail\": \"cillum officia\",\n \"title\": \"in sunt\",\n \"status\": \"reprehenderit in in deserunt labore\"\n }\n ]\n}" } ] }, { "name": "Reopen Case Webook", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"EVENT_ID\": 18,\n \"HTTP_POST_ADDRESS\": ,\n \"HEADERS\": {\n \"Authorization\": {\n \"type\": \"OaUth2\",\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"{{client_id}}\",\n \"client_secret\": \"{{client_secret}}\",\n \"token_url\": \"{{authTokenURL}}\"\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/webhooks/register", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", "register" ] }, "description": "

Subscribe to a webhook that will be called when the specified event in Hi Marley occurs.\nEach webhook has a potentially different required request body based on the functionality and configuration

View the different example request bodies below for different webhook subscriptions

Hi Marley Webhook Overview

\n" }, "response": [ { "name": "Webhook successfully registered", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"EVENT_ID\": 3,\n \"PGP_KEY\": \"BASE64_PGP_KEY_FOR_OPTIONAL_ENCRYPTION\",\n \"format\": \"${caseData.brand}/${primaryContact.first}-${primaryContact.last}/${partialId}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/webhooks/register", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", "register" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"REGISTERED_PAYLOAD\": {\n \"EVENT_ID\": -3838413,\n \"HTTP_POST_ADDRESS\": \"commodo cillum ullamco\",\n \"HEADERS\": [\n \"tempor consequat Ut\",\n \"pariatur anim consectetur et in\"\n ]\n },\n \"SUBSCRIPTION_ID\": \"11\",\n \"EVENT\": \"CLOSE_CASE\"\n}" }, { "name": "Standard Error from Marley.\nFormat is consistent for all failure status codes, even though documentation only shows 400 error code responses.\n", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"EVENT_ID\": 3,\n \"PGP_KEY\": \"BASE64_PGP_KEY_FOR_OPTIONAL_ENCRYPTION\",\n \"format\": \"${caseData.brand}/${primaryContact.first}-${primaryContact.last}/${partialId}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/webhooks/register", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", "register" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errors\": [\n {\n \"meta\": {},\n \"detail\": \"dolore mollit\",\n \"title\": \"elit sunt tempor do\",\n \"status\": \"officia irure\"\n },\n {\n \"meta\": {},\n \"detail\": \"cillum officia\",\n \"title\": \"in sunt\",\n \"status\": \"reprehenderit in in deserunt labore\"\n }\n ]\n}" } ] }, { "name": "Close Case Webook", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"EVENT_ID\": 10,\n \"HTTP_POST_ADDRESS\": ,\n \"HEADERS\": {\n \"Authorization\": {\n \"type\": \"OaUth2\",\n \"grant_type\": \"client_credentials\",\n \"client_id\": \"{{client_id}}\",\n \"client_secret\": \"{{client_secret}}\",\n \"token_url\": \"{{authTokenURL}}\"\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/webhooks/register", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", "register" ] }, "description": "

Subscribe to a webhook that will be called when the specified event in Hi Marley occurs.\nEach webhook has a potentially different required request body based on the functionality and configuration

View the different example request bodies below for different webhook subscriptions

Hi Marley Webhook Overview

\n" }, "response": [ { "name": "Webhook successfully registered", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"EVENT_ID\": 3,\n \"PGP_KEY\": \"BASE64_PGP_KEY_FOR_OPTIONAL_ENCRYPTION\",\n \"format\": \"${caseData.brand}/${primaryContact.first}-${primaryContact.last}/${partialId}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/webhooks/register", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", "register" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"REGISTERED_PAYLOAD\": {\n \"EVENT_ID\": -3838413,\n \"HTTP_POST_ADDRESS\": \"commodo cillum ullamco\",\n \"HEADERS\": [\n \"tempor consequat Ut\",\n \"pariatur anim consectetur et in\"\n ]\n },\n \"SUBSCRIPTION_ID\": \"11\",\n \"EVENT\": \"CLOSE_CASE\"\n}" }, { "name": "Standard Error from Marley.\nFormat is consistent for all failure status codes, even though documentation only shows 400 error code responses.\n", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"EVENT_ID\": 3,\n \"PGP_KEY\": \"BASE64_PGP_KEY_FOR_OPTIONAL_ENCRYPTION\",\n \"format\": \"${caseData.brand}/${primaryContact.first}-${primaryContact.last}/${partialId}\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/webhooks/register", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", "register" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errors\": [\n {\n \"meta\": {},\n \"detail\": \"dolore mollit\",\n \"title\": \"elit sunt tempor do\",\n \"status\": \"officia irure\"\n },\n {\n \"meta\": {},\n \"detail\": \"cillum officia\",\n \"title\": \"in sunt\",\n \"status\": \"reprehenderit in in deserunt labore\"\n }\n ]\n}" } ] } ] } ], "auth": { "type": "apikey", "apikey": [ { "key": "value", "value": "{{x-api-key}}", "type": "string" }, { "key": "key", "value": "x-api-key", "type": "string" } ] }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }