{ "item": [ { "id": "943a528a-6024-468e-94bd-d84fd5557d19", "name": "Integration Mappings", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "b69a97bb-523c-4248-8bb3-e856d4093876", "name": "Index Integration Mappings", "request": { "name": "Index Integration Mappings", "description": {}, "url": { "path": [ "api", "v1", "integration_mappings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a7e868eb-accb-44ae-89f1-77971671ef02", "name": "Successful", "originalRequest": { "url": { "path": [ "api", "v1", "integration_mappings" ], "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\": \"integration_mappings\",\n \"attributes\": {\n \"jebbit_var\": \"Outcome\",\n \"client_var\": \"Bucket\",\n \"integration_id\": \"asdf1234\"\n }\n },\n {\n \"id\": \"def567\",\n \"type\": \"integration_mappings\",\n \"attributes\": {\n \"jebbit_var\": \"Outcome\",\n \"client_var\": \"Bucket\",\n \"integration_id\": \"zmejas58\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e6f74af-ba61-4b2e-94b5-ea0644c04e1a", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "integration_mappings" ], "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": "63e07277-8966-4e4e-beda-1c5a1b1681e5", "name": "forbidden", "originalRequest": { "url": { "path": [ "api", "v1", "integration_mappings" ], "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": "44017481-53ed-44f2-b776-7ae0cfbc35a5", "name": "integration_mappings", "request": { "name": "integration_mappings", "description": {}, "url": { "path": [ "api", "v1", "integration_mappings" ], "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": "", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9cd5761f-68ab-448b-9c1e-9e5a8230f88f", "name": "Created", "originalRequest": { "url": { "path": [ "api", "v1", "integration_mappings" ], "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": "", "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_mappings\",\n \"attributes\": {\n \"jebbit_var\": \"Outcome\",\n \"client_var\": \"Bucket\",\n \"default\": \"Default\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "88d74ee6-260a-40f7-91e3-8de45a3848dc", "name": "bad request -- Invalid 'jebbit_var' cannot be '$metadata'", "originalRequest": { "url": { "path": [ "api", "v1", "integration_mappings" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "96e88a34-910e-4272-aa34-beddd8cadd1f", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "integration_mappings" ], "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": "", "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": "53a44f0e-0384-4a72-9894-9e961c0deda3", "name": "forbidden", "originalRequest": { "url": { "path": [ "api", "v1", "integration_mappings" ], "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": "", "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": "a628b106-1495-41cf-8655-8dd4a89e659d", "name": "bad request (no params given)", "originalRequest": { "url": { "path": [ "api", "v1", "integration_mappings" ], "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": "", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/vnd.api+json" } ], "body": "{\n \"data\": {\n \"id\": \"abc123\",\n \"type\": \"integration_mappings\",\n \"attributes\": {\n \"name\": \"Jebbit\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a17baf53-6b6f-4da7-a4ee-06e6fa40ea5f", "name": "Shows an Integration Mapping", "request": { "name": "Shows an Integration Mapping", "description": {}, "url": { "path": [ "api", "v1", "integration_mappings", ":integration_mapping_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "integration_mapping_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "12a93e40-59c8-49c8-bf4f-4f6a4b11662e", "name": "Successful", "originalRequest": { "url": { "path": [ "api", "v1", "integration_mappings", ":integration_mapping_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "integration_mapping_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_mappings\",\n \"attributes\": {\n \"jebbit_var\": \"Outcome\",\n \"client_var\": \"Bucket\",\n \"default\": \"Default\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5c7218fd-b335-40ce-8e6f-51277dbb6f91", "name": "update integration mapping", "request": { "name": "update integration mapping", "description": {}, "url": { "path": [ "api", "v1", "integration_mappings", ":integration_mapping_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "integration_mapping_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": "1f5b1211-5c79-44ae-952c-3251cb5433bc", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "integration_mappings", ":integration_mapping_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "integration_mapping_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": "0278dfb1-b7cc-4c93-bec0-1a331441b45e", "name": "forbidden", "originalRequest": { "url": { "path": [ "api", "v1", "integration_mappings", ":integration_mapping_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "integration_mapping_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": "5d99ac03-d4ca-46b0-b977-bb97e12d8ee6", "name": "not found", "originalRequest": { "url": { "path": [ "api", "v1", "integration_mappings", ":integration_mapping_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "integration_mapping_id", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "94817a78-ea20-421a-bf1a-da06aa17b4fa", "name": "Delete an Integration Mapping", "request": { "name": "Delete an Integration Mapping", "description": {}, "url": { "path": [ "api", "v1", "integration_mappings", ":integration_mapping_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "integration_mapping_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/vnd.api+json" } ], "method": "DELETE", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "d71775b9-4a44-4100-80c8-135daa91f45d", "name": "No Conent", "originalRequest": { "url": { "path": [ "api", "v1", "integration_mappings", ":integration_mapping_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "integration_mapping_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": "6f14919c-4099-481e-a76f-56e385cf6393", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "api", "v1", "integration_mappings", ":integration_mapping_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "integration_mapping_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": "a1e1a3a6-2546-4916-a7ff-4f902c856939", "name": "forbidden", "originalRequest": { "url": { "path": [ "api", "v1", "integration_mappings", ":integration_mapping_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "integration_mapping_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": "00605372-d007-4751-831a-c9ac45d7038d", "name": "not found", "originalRequest": { "url": { "path": [ "api", "v1", "integration_mappings", ":integration_mapping_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "integration_mapping_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 } } ], "event": [] } ], "event": [], "variable": [ { "type": "string", "value": "https://api2.jebbit.com/", "key": "baseUrl" } ], "info": { "_postman_id": "8d6d347c-0c55-4493-bcb1-1c84301df073", "name": "Jebbit Auth Integration Mappings 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" } } }