{ "item": [ { "id": "5c7e0d60-2ce5-401d-acfa-9cd3c714a838", "name": "Integrations", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "f943b709-3050-4625-8327-e6d2661348d4", "name": "integrations", "request": { "name": "integrations", "description": {}, "url": { "path": [ "api", "v1", "integrations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "5e4d2832-98b7-4291-8bed-c019b59373f7", "name": "Successful", "originalRequest": { "url": { "path": [ "api", "v1", "integrations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": [\n {\n \"id\": \"abc123\",\n \"type\": \"integrations\",\n \"attributes\": {\n \"endpoint\": \"https://www.example.com/webhook\",\n \"service_name\": \"webhook\"\n }\n },\n {\n \"id\": \"def567\",\n \"type\": \"integrations\",\n \"attributes\": {\n \"endpoint\": \"https://www.example.com/webhook2\",\n \"service_name\": \"webhook\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49ea3ed3-8266-45a7-9494-4477ba46f8ed", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "integrations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 401,\n \"title\": \"Unauthorized Request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8e4942a-5246-43c1-a585-c8d626a05675", "name": "forbidden", "originalRequest": { "url": { "path": [ "api", "v1", "integrations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 403,\n \"title\": \"Forbidden\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e409f078-e4ee-4e06-a3ae-90e4e90f07f9", "name": "integrations", "request": { "name": "integrations", "description": {}, "url": { "path": [ "api", "v1", "integrations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"integrations\",\n \"attributes\": {\n \"endpoint\": \"\",\n \"region\": \"us\",\n \"additional_options\": {\n \"campaign_name_filter\": \"\",\n \"include_url_params\": \"\",\n \"include_sub_channel\": \"\",\n \"include_outcome_names\": \"\",\n \"require_outcomes\": \"\",\n \"hash_pii\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ca8d195c-8ddd-4534-b450-5c4d94b124cf", "name": "Successful", "originalRequest": { "url": { "path": [ "api", "v1", "integrations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"integrations\",\n \"attributes\": {\n \"endpoint\": \"\",\n \"region\": \"us\",\n \"additional_options\": {\n \"campaign_name_filter\": \"\",\n \"include_url_params\": \"\",\n \"include_sub_channel\": \"\",\n \"include_outcome_names\": \"\",\n \"require_outcomes\": \"\",\n \"hash_pii\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"abc123\",\n \"type\": \"integration\",\n \"attributes\": {\n \"name\": \"Jebbit\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "471eeadd-bf90-4310-be79-6a34941d4db0", "name": "bad request - must be a valid region (us|eu)", "originalRequest": { "url": { "path": [ "api", "v1", "integrations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"integrations\",\n \"attributes\": {\n \"endpoint\": \"\",\n \"region\": \"us\",\n \"additional_options\": {\n \"campaign_name_filter\": \"\",\n \"include_url_params\": \"\",\n \"include_sub_channel\": \"\",\n \"include_outcome_names\": \"\",\n \"require_outcomes\": \"\",\n \"hash_pii\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"abc123\",\n \"type\": \"integration\",\n \"attributes\": {\n \"name\": \"Jebbit\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57b1a9c0-8438-4a6d-80cb-273d0924fa5f", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "integrations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"integrations\",\n \"attributes\": {\n \"endpoint\": \"\",\n \"region\": \"us\",\n \"additional_options\": {\n \"campaign_name_filter\": \"\",\n \"include_url_params\": \"\",\n \"include_sub_channel\": \"\",\n \"include_outcome_names\": \"\",\n \"require_outcomes\": \"\",\n \"hash_pii\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 401,\n \"title\": \"Unauthorized Request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6f34eb7-572c-4039-b340-725318786190", "name": "forbidden", "originalRequest": { "url": { "path": [ "api", "v1", "integrations" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"type\": \"integrations\",\n \"attributes\": {\n \"endpoint\": \"\",\n \"region\": \"us\",\n \"additional_options\": {\n \"campaign_name_filter\": \"\",\n \"include_url_params\": \"\",\n \"include_sub_channel\": \"\",\n \"include_outcome_names\": \"\",\n \"require_outcomes\": \"\",\n \"hash_pii\": \"\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 403,\n \"title\": \"Forbidden\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2100a34f-4d51-4457-99de-a164f8a56d4b", "name": "Retrieves an Integration", "request": { "name": "Retrieves an Integration", "description": {}, "url": { "path": [ "api", "v1", "integrations", ":integration_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "integration_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "d550d336-9044-4ab0-870a-449b2c44e173", "name": "Successful", "originalRequest": { "url": { "path": [ "api", "v1", "integrations", ":integration_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "integration_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"abc123\",\n \"type\": \"integration\",\n \"attributes\": {\n \"name\": \"Jebbit\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "844f2c2d-e340-4cd1-9c15-bf3b98a6ea82", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "integrations", ":integration_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "integration_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 401,\n \"title\": \"Unauthorized Request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb31b74c-3b03-43ff-a8c0-351afa213080", "name": "forbidden", "originalRequest": { "url": { "path": [ "api", "v1", "integrations", ":integration_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "integration_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 403,\n \"title\": \"Forbidden\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "860d0a1a-3c3a-4932-ae1f-330839f1c2cd", "name": "not found", "originalRequest": { "url": { "path": [ "api", "v1", "integrations", ":integration_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "integration_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4be8274c-b758-4684-a980-d3f5438b2605", "name": "Updates an Integration", "request": { "name": "Updates an Integration", "description": {}, "url": { "path": [ "api", "v1", "integrations", ":integration_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "integration_id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "PATCH", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] }, "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "d2f954c8-55ab-4729-bfcc-335c9921ca01", "name": "Successful", "originalRequest": { "url": { "path": [ "api", "v1", "integrations", ":integration_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "integration_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"abc123\",\n \"type\": \"integration\",\n \"attributes\": {\n \"name\": \"Jebbit\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97dee15c-359d-412a-98f3-e66b0cfd7c5c", "name": "bad request", "originalRequest": { "url": { "path": [ "api", "v1", "integrations", ":integration_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "integration_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"abc123\",\n \"type\": \"integration\",\n \"attributes\": {\n \"name\": \"Jebbit\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01a40ad8-0bc8-4c7c-8a39-396d4fc5acf5", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "integrations", ":integration_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "integration_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 401,\n \"title\": \"Unauthorized Request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5b688f1-9a44-49ff-b051-7768ea2cd0ba", "name": "forbidden", "originalRequest": { "url": { "path": [ "api", "v1", "integrations", ":integration_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "integration_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 403,\n \"title\": \"Forbidden\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "852c7a2e-a086-4539-ad14-85edfd06903b", "name": "not found", "originalRequest": { "url": { "path": [ "api", "v1", "integrations", ":integration_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "integration_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"abc123\",\n \"type\": \"integration\",\n \"attributes\": {\n \"name\": \"Jebbit\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b096c4b9-b2c7-4533-b815-a77ca8787d60", "name": "Delete an Integration", "request": { "name": "Delete an Integration", "description": {}, "url": { "path": [ "api", "v1", "integrations", ":integration_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "integration_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e526771d-c21f-4cfb-afd6-f370d48f3593", "name": "No Conent", "originalRequest": { "url": { "path": [ "api", "v1", "integrations", ":integration_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "integration_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2eeec511-f52d-4a3a-9159-d59f7bc95b93", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "integrations", ":integration_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "integration_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 401,\n \"title\": \"Unauthorized Request\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d6a2838-3f08-4120-9ab4-60142bc5d07b", "name": "forbidden", "originalRequest": { "url": { "path": [ "api", "v1", "integrations", ":integration_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "integration_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"errors\": [\n {\n \"status\": 403,\n \"title\": \"Forbidden\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e479213d-6c98-4a97-99d2-d42544c7d8a7", "name": "not found", "originalRequest": { "url": { "path": [ "api", "v1", "integrations", ":integration_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "integration_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "78a6be75-643d-4e3c-a49b-a3d31e769226", "name": "Send A test Integration Submission", "request": { "name": "Send A test Integration Submission", "description": {}, "url": { "path": [ "api", "v1", "integrations", ":integration_id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "integration_id", "description": "(Required) " } ] }, "method": "POST", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "41487614-8d54-43be-b652-e75526169ea8", "name": "Successful", "originalRequest": { "url": { "path": [ "api", "v1", "integrations", ":integration_id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "integration_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "type": "string", "value": "https://api2.jebbit.com/", "key": "baseUrl" } ], "info": { "_postman_id": "306f305a-4c30-4e9a-a605-b85801b641ef", "name": "Jebbit Auth Integrations API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "# Introduction\nUse our Jebbit API to automate tasks relating to your Jebbit Businesses, Campaigns, Product Feed, Launch Links, and Integrations.\n# Authentication Guide\nUse the `client_id` and `client_secret` provided by Jebbit in the [Auth Endpoint](/#tag/Auth) to generate an `access_token`. This token is valid for 24 hours. After that you'll need to hit the endpoint again to generate a new token.\n## Making API Requests\nJebbit requires your `access_token` (which is a [Json Web Token](https://jwt.io/) / JWT) to be included in all API requests. It must be sent in the `Authorization` header in the following format:\n\n`Authorization: Bearer `\n\n**Important:** If your `access_token` has permissions (scopes) to multiple businesses, then we require you to send an `x-jebbit-business` header with every request. The value of this header is a business' ID. This header sets the scope of the request to the business provided.\n## API Resource Sorting\nAll resources from the API are listed descending by the time they were created.\n# Integration/Webhook Client Guide\nWhen using our [Integrations endpoint](/#tag/Integrations) to receive Jebbit webhooks there are a few key things you want to keep top-of-mind. To help assist in this process, we've created an [Example Webhook Client Repo](https://github.com/jebbit/jebbit-webhook-client-example) as a kickstarter.\n## Test Webhooks\nYou're able to [send a test webhook](/#tag/Integrations/) to your endpoint to verify that your integration and endpoint are properly set up. Test Webhooks allow you to test out the signature verification process before activating your Integration.\n\n**Important:** Jebbit sends an `x-jebbit-test` header with every test webhook. You should ensure there is logic in your application to properly discard these webhooks and not continue processing them through your data ingestion process.\n## Jebbit Webhooks\nAll webhooks Jebbit sends contain an `x-jebbit-signature` header. This header is how you can verify that the request to your endpoint is from Jebbit.\n## Anatomy of a Jebbit Signature\nThe value of a Jebbit Signature will be a string with two key/value pairs separated by a comma. The first part is the unix timestamp of when the webhook was sent and the second part is the hmac of the payload it carries.\n`x-jebbit-signature: t=#{timestamp},v1=#{hmac}`\n## Verifying a Signature\nThe first step of validating a signature is ensuring that the timestamp provided is within a reasonable threshold from the current timestamp, say 5 minutes. If a webhook is outside of this threshold it is recommended to not process it any further -- this helps guard against replay attacks.\n\n\n```ruby\n# Example in Ruby\nif timestamp < Time.now.to_i - 300 # 300 seconds = 5 minutes\n raise StandardError, 'Timestamp outside of tolerance'\nend\n```\n\nThe next step will be to verify the `hmac` passed along by the `v1` attribute of the signature. To verify this you'll need to do the following:\n\n```ruby\n# Example in Ruby/Rails\n# Step 1 - regenerate the payload by using the timestamp the header\ngenerated_payload = \"#{timestamp}.#{request.body}\"\n\n# Step 2 - create an HMAC of the generated_payload using the `shared_secret` for the integration\n\ncalculated_hmac = Base64.strict_encode64(\n OpenSSL::HMAC.digest('sha256', shared_secret, generated_payload)\n)\n\n# Step 3 - securely verify that the two hmacs are equal\nActiveSupport::SecurityUtils.secure_compare(hmac, calculated_hmac)\n\n# if they are equal, then you can accept the payload as valid & continue processing.\n```\n", "type": "text/plain" } } }