Rise.ai API was built to help you make complicated Gift Card & Credit integrations easy - from Point of Sales to advanced 3rd party integrations.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"18108494","collectionId":"89ff7980-4277-4b78-b370-ff9ce6c17601","publishedId":"UzXNUchn","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FFD748"},"publishDate":"2024-02-19T20:35:30.000Z"},"item":[{"name":"How to start?","item":[],"id":"3e73e1de-2693-41f9-a0dd-7b7d25cdb43c","description":"In order to start using the API you'll need to receive your access_token. Send an email to dev@rise.ai / your dedicated account manager and we will assist you.
Apps can make requests at a maximum rate of 2 requests/second.
any requests exceeding this limit will result in 429 Too Many Requests error
Contact our developers support at dev@rise.ai
Rise.ai API access token
\n","key":"x-rise-access-token","type":"text","value":"XXXX-XXXX-XXXX-XXXX"}],"body":{"mode":"raw","raw":""},"url":"https://application.rise-ai.com/v2/gift-cards/?shop_url=amazingshop.myshopify.com&code=xxxxxxxxxxxxxxxx","description":"Retrieves a single Gift Card by its code.
\n","urlObject":{"protocol":"https","path":["v2","gift-cards",""],"host":["application","rise-ai","com"],"query":[{"description":{"content":"The Shopify shop domain
\n","type":"text/plain"},"key":"shop_url","value":"amazingshop.myshopify.com"},{"description":{"content":"The Gift Card actual code
\n","type":"text/plain"},"key":"code","value":"xxxxxxxxxxxxxxxx"}],"variable":[]}},"response":[{"id":"04708615-b43d-4c04-8de6-8fff8e033975","name":"Get Gift Card","originalRequest":{"method":"GET","header":[{"description":"Rise.ai API access token","key":"x-rise-access-token","type":"text","value":"XXXX-XXXX-XXXX-XXXX"}],"url":{"raw":"https://application.rise-ai.com/v2/gift-cards/?shop_url=amazingshop.myshopify.com&code=xxxxxxxxxxxxxxxx","protocol":"https","host":["application","rise-ai","com"],"path":["v2","gift-cards",""],"query":[{"key":"shop_url","value":"amazingshop.myshopify.com","description":"The Shopify shop domain"},{"key":"code","value":"xxxxxxxxxxxxxxxx","description":"The Gift Card actual code"}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"amount\": 10,\n \"gift_card_id\": \"AAAA-AAAA-AAAA-AAAA\",\n \"expires_on\": \"01/01/2028\",\n \"code\": \"•••• •••• •••• xxxx\"\n}"}],"_postman_id":"22c6b818-9a8c-4ce1-8521-a0c60623c653"},{"name":"Get Customer Loyalty Card","id":"9671c113-c224-4642-9bc9-6501faa180df","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"Rise.ai API access token
\n","key":"x-rise-access-token","type":"text","value":"XXXX-XXXX-XXXX-XXXX"}],"body":{"mode":"raw","raw":""},"url":"https://application.rise-ai.com/v2/gift-cards/?customer_id=123456789&shop_url=amazingshop.myshopify.com","description":"Retrieves the Loyalty Card of the provided customer.
\n","urlObject":{"protocol":"https","path":["v2","gift-cards",""],"host":["application","rise-ai","com"],"query":[{"description":{"content":"The Shopify Customer Id
\n","type":"text/plain"},"key":"customer_id","value":"123456789"},{"description":{"content":"The Shopify shop domain
\n","type":"text/plain"},"key":"shop_url","value":"amazingshop.myshopify.com"}],"variable":[]}},"response":[{"id":"bf3e59a3-a118-4a41-9c8b-964c549736ca","name":"Get Customer Loyalty Card","originalRequest":{"method":"GET","header":[{"description":"Rise.ai API access token","key":"x-rise-access-token","type":"text","value":"XXXX-XXXX-XXXX-XXXX"}],"url":{"raw":"https://application.rise-ai.com/v2/gift-cards/?customer_id=123456789&shop_url=amazingshop.myshopify.com","protocol":"https","host":["application","rise-ai","com"],"path":["v2","gift-cards",""],"query":[{"key":"customer_id","value":"123456789","description":"The Shopify Customer Id"},{"key":"shop_url","value":"amazingshop.myshopify.com","description":"The Shopify shop domain"}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"amount\": 10,\n \"gift_card_id\": \"AAAA-AAAA-AAAA-AAAA\",\n \"expires_on\": \"01/01/2028\",\n \"code\": \"xxxxxxxxxxxxxxxx\"\n}"}],"_postman_id":"9671c113-c224-4642-9bc9-6501faa180df"},{"name":"Issue Gift Card","id":"295117ea-3319-461b-bbbf-0236b7e53ddb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Rise.ai API access token
\n","key":"x-rise-access-token","type":"text","value":"XXXX-XXXX-XXXX-XXXX"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"gift_card\": {\n \"balance\": 100,\n \"note\":\"\" // optional\n },\n \"email_details\": {\n \"recipient\": \"recipientName\",\n \"title\": \"Cool mail\",\n \"subject\": \"Hello this is a reason giftcard\",\n \"body\": \"This is some reason I give you a gift card\",\n \"recipient_email\": \" happy_customer@gmail.com \"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://application.rise-ai.com/v2/gift-cards/issue/?shop_url=amazingshop.myshopify.com","description":"Creates & Send a Gift Card.
\n","urlObject":{"protocol":"https","path":["v2","gift-cards","issue",""],"host":["application","rise-ai","com"],"query":[{"description":{"content":"The Shopify shop domain
\n","type":"text/plain"},"key":"shop_url","value":"amazingshop.myshopify.com"}],"variable":[]}},"response":[{"id":"0bf95618-f2de-433c-86c8-9c658848654e","name":"Issue Gift Card","originalRequest":{"method":"POST","header":[{"description":"Rise.ai API access token","key":"x-rise-access-token","type":"text","value":"XXXX-XXXX-XXXX-XXXX"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"gift_card\": {\n \"balance\": 100\n },\n \"email_details\": {\n \"recipient\": \"recipientName\",\n \"title\": \"Cool mail\",\n \"subject\": \"Hello this is a reason giftcard\",\n \"body\": \"This is some reason I give you a gift card\",\n \"recipient_email\": \" happy_customer@gmail.com \"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://application.rise-ai.com/v2/gift-cards/issue/?shop_url=amazingshop.myshopify.com","protocol":"https","host":["application","rise-ai","com"],"path":["v2","gift-cards","issue",""],"query":[{"key":"shop_url","value":"amazingshop.myshopify.com","description":"The Shopify shop domain"}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"gift_card\": {\n \"gift_card_id\": \"AAAA-AAAA-AAAA-AAAA\",\n \"balance\": 100,\n \"initial_value\": 100,\n \"expires_on\": \"01/01/2028\",\n \"code\": \"xxxxxxxxxxxxxxxx\"\n }\n}"}],"_postman_id":"295117ea-3319-461b-bbbf-0236b7e53ddb"},{"name":"Adjust Gift Card Balance","id":"d8bc6213-8d25-4fbf-a779-e4f6377fd2b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"description":"Rise.ai API access token
\n","key":"x-rise-access-token","type":"text","value":"XXXX-XXXX-XXXX-XXXX"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": 10,\n \"type\": \"order/refund\",\n \"order_id\": \"1234567890\"\n}","options":{"raw":{"language":"json"}}},"url":"https://application.rise-ai.com/v2/gift-cards/AAAA-AAAA-AAAA-AAAA?shop_url=amazingshop.myshopify.com","description":"Adjust the balance of an existing Gift Card.
\nAdjustment type can be either \"order\" or \"refund\".
\n","urlObject":{"protocol":"https","path":["v2","gift-cards","AAAA-AAAA-AAAA-AAAA"],"host":["application","rise-ai","com"],"query":[{"description":{"content":"The Shopify shop domain
\n","type":"text/plain"},"key":"shop_url","value":"amazingshop.myshopify.com"}],"variable":[]}},"response":[{"id":"2b74d956-e3c0-4bd2-bf30-c18cd07f4bc1","name":"Adjust Gift Card Balance","originalRequest":{"method":"PUT","header":[{"description":"Rise.ai API access token","key":"x-rise-access-token","type":"text","value":"XXXX-XXXX-XXXX-XXXX"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": 10,\n \"type\": \"order\",\n \"order_id\": \"1234567890\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://application.rise-ai.com/v2/gift-cards/AAAA-AAAA-AAAA-AAAA?shop_url=amazingshop.myshopify.com","protocol":"https","host":["application","rise-ai","com"],"path":["v2","gift-cards","AAAA-AAAA-AAAA-AAAA"],"query":[{"key":"shop_url","value":"amazingshop.myshopify.com","description":"The Shopify shop domain"}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"gift_card\": {\n \"gift_card_id\": \"AAAA-AAAA-AAAA-AAAA\",\n \"balance\": 90,\n \"expires_on\": \"01/01/2028\",\n \"code\": \"xxxxxxxxxxxxxxxx\"\n }\n}"}],"_postman_id":"d8bc6213-8d25-4fbf-a779-e4f6377fd2b1"},{"name":"Get Referral Link","id":"9d022da2-3621-44c1-b761-a76d4918a8ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://application.rise-ai.com/integrations/inbound/referrals/customer_Id?shop_url=amazingshop.myshopify.com","description":"Get a customer's referral link if it exists.
\n","urlObject":{"protocol":"https","path":["integrations","inbound","referrals","customer_Id"],"host":["application","rise-ai","com"],"query":[{"key":"shop_url","value":"amazingshop.myshopify.com"}],"variable":[]}},"response":[{"id":"ecb25f56-fcbe-4cdf-8908-5e85b0c9c4df","name":"Get Referral Link","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://application.rise-ai.com/integrations/inbound/referrals/:customer_id?shop_url=amazingshop.myshopify.com","protocol":"https","host":["application","rise-ai","com"],"path":["integrations","inbound","referrals",":customer_id"],"query":[{"key":"shop_url","value":"amazingshop.myshopify.com"}],"variable":[{"key":"customer_id","value":""}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"referral_link\": \"https://lnk.rise-ai.com/*********,\n \"discount_code\": \"*********\",\n \"number_of_clicks\": 10,\n \"Number_of_successful_referrals\": 10\n}"}],"_postman_id":"9d022da2-3621-44c1-b761-a76d4918a8ee"},{"name":"Create a Referral Link","id":"c457ec23-48de-4bae-b838-49212470d56d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-rise-access-token","value":"XXXX-XXXX-XXXX-XXXX","type":"text"}],"url":"https://application.rise-ai.com/integrations/inbound/referrals/customer_Id?shop_url=amazingshop.myshopify.com","description":"Creates a referral link for a customer.
\n","urlObject":{"protocol":"https","path":["integrations","inbound","referrals","customer_Id"],"host":["application","rise-ai","com"],"query":[{"key":"shop_url","value":"amazingshop.myshopify.com"}],"variable":[]}},"response":[{"id":"2a3956f8-d507-49e2-84ef-794586d602c0","name":"Create a Referral Link","originalRequest":{"method":"POST","header":[{"key":"x-rise-access-token","value":"XXXX-XXXX-XXXX-XXXX","type":"text"}],"url":{"raw":"https://application.rise-ai.com/integrations/inbound/referrals/:customer_id?shop_url=amazingshop.myshopify.com","protocol":"https","host":["application","rise-ai","com"],"path":["integrations","inbound","referrals",":customer_id"],"query":[{"key":"shop_url","value":"amazingshop.myshopify.com"}],"variable":[{"key":"customer_id","value":""}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"referral_link\": \"https://lnk.rise-ai.com/*********\",\n \"discount_code\": \"*********\"\n}"}],"_postman_id":"c457ec23-48de-4bae-b838-49212470d56d"}],"id":"3eeb9f2b-d0bf-4ad8-8955-a2a4dd299ddb","description":"Rise.ai's Credit API allows you to Issue, Get & Adjust Gift Cards, Loyalty Cards and Customer Referral links.
\n","_postman_id":"3eeb9f2b-d0bf-4ad8-8955-a2a4dd299ddb"},{"name":"Gifting API","item":[{"name":"Developer Guide","item":[],"id":"378f7cc7-2d05-4afe-908b-8f0dadbffa82","description":"\n\n
\n\n
Upon the entrance of a buyer to the gift card page, you should create a session.
\nA Session id is saved on a cookie called rise_gifting_session. This cookie will be saved for 14 days.\nUse the session id (saved on the cookie) for all requests for this customer while the cookie is still available.\nThe cookie’s expiration date will reset each time there is a request to the gifting API.
Once the buyer adds a gift to the cart, the developer must create the gift at Rise.ai via the API. The response will return a gift object.
\n\n
\n\n
\n\n
Once the gift is created, the gift id must be added to the cart's line-items.\nOn Shopify, use the cart API.
We expect the id's line item property name to be _id.\nThe line_items properties on the order should be as followed.
properties: [\n {\n name: \"_id\",\n value: \"598983651\"\n }\n ]\nIf you are not using Shopify, make sure that the gift id is added to the order line-item properties at the initial creation of the order.
\n\n
\n\n
Once a checkout is completed, the developer must send a session-completed request. The session will be processed and the gift cards will be created.\nThis request must be made immediately after the checkout complete event in order to avoid gift card sending issues.
\n\n\n
After the orders/paid webhook is received, the gift cards will be sent.
\n","_postman_id":"378f7cc7-2d05-4afe-908b-8f0dadbffa82"},{"name":"API Reference","item":[{"name":"Session","item":[{"name":"Init Gifting Session","id":"62d1326a-db66-41eb-8129-7c7292c19b50","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-rise-gifting-api-key","value":"XXXX-XXXX-XXXX-XXXX","description":"Rise.ai API access token
\n","type":"text"}],"url":"https://application.rise-ai.com/integrations/inbound/gifting/session","urlObject":{"protocol":"https","path":["integrations","inbound","gifting","session"],"host":["application","rise-ai","com"],"query":[],"variable":[]}},"response":[{"id":"1fb13ac3-626f-4d0e-8d4e-c0092779a9a6","name":"Init Gifting Session","originalRequest":{"method":"POST","header":[{"key":"x-rise-gifting-api-key","value":"XXXX-XXXX-XXXX-XXXX","description":"Rise.ai API access token","type":"text"}],"url":"https://application.rise-ai.com/integrations/inbound/gifting/session"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 12 Apr 2021 11:22:57 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"57"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"39-UduJsuiRwUla5WV/HNYSaoHTbxQ\""},{"key":"Set-Cookie","value":"rise_gifting_session=j%3A%7B%22session%22%3A%7B%22id%22%3A%22d50c6478-2095-47f6-89a6-a2754e64d254%22%7D%7D; Path=/; Expires=Mon, 26 Apr 2021 11:22:57 GMT; Secure"},{"key":"X-Powered-By","value":"Express"},{"key":"X-Rise-Api-Bucket-Consumed","value":"1"},{"key":"X-Rise-Api-Bucket-Limit","value":"40"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"cf-request-id","value":"09676b17b9000040ea98a14000000001"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report?s=5dYldKeYj5sV5WA%2BW%2BdetjlONwYQ4NihyCFt%2FWTNdufn1Civj8ub3zW8ydibUQlLqJb%2Bw3Fg3CJ0mxY7aungHRrY2TehsvmKiigmPTs0QXSl5U8hQDwzjT7QnmhzAA%3D%3D\"}]}"},{"key":"NEL","value":"{\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"63ec146c5f5940ea-LHR"}],"cookie":[],"responseTime":null,"body":"{\n \"session\": {\n \"id\": \"d50c6478-2095-47f6-89a6-a2754e64d254\"\n }\n}"}],"_postman_id":"62d1326a-db66-41eb-8129-7c7292c19b50"},{"name":"Get Session","id":"131b51fa-6cd8-4c4e-88e4-643d79028af9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-rise-gifting-api-key","value":"XXXX-XXXX-XXXX-XXXX","description":"Rise.ai API access token
\n","type":"text"}],"url":"https://application.rise-ai.com/integrations/inbound/gifting/session/:session_id?shop_url=amazingshop.myshopify.com","urlObject":{"protocol":"https","path":["integrations","inbound","gifting","session",":session_id"],"host":["application","rise-ai","com"],"query":[{"description":{"content":"The Shopify shop domain
\n","type":"text/plain"},"key":"shop_url","value":"amazingshop.myshopify.com"}],"variable":[{"description":{"content":"The recevied session id
\n","type":"text/plain"},"type":"any","value":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","key":"session_id"}]}},"response":[{"id":"c78e3d35-c007-4d61-9485-8cf48aa626d0","name":"Get Session","originalRequest":{"method":"GET","header":[{"key":"x-rise-gifting-api-key","value":"XXXX-XXXX-XXXX-XXXX","description":"Rise.ai API access token","type":"text"}],"url":"https://application.rise-ai.com/integrations/inbound/gifting/session/d50c6478-2095-47f6-89a6-a2754e64d254"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 12 Apr 2021 13:00:36 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"26e-a/smcUToUnUWWMF2pnTdXx53oNA\""},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"Express"},{"key":"X-Rise-Api-Bucket-Consumed","value":"1"},{"key":"X-Rise-Api-Bucket-Limit","value":"40"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"cf-request-id","value":"0967c47f1a000040ccbda60000000001"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report?s=%2Fm%2FNDGisezXpL%2F%2B6mnlkbuipdOwP2fgX5IMeHfSbP%2Fg68ucmXZqkBAFqYAhGeQN%2FlHw8upSnDO2ILiD%2BPlrsAXXMbljgJadYGOqt97g3d0Fb0274xo%2FnjFSb1ZzUwA%3D%3D\"}],\"max_age\":604800}"},{"key":"NEL","value":"{\"max_age\":604800,\"report_to\":\"cf-nel\"}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"63eca3782d6340cc-LHR"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"session\": {\n \"id\": \"d50c6478-2095-47f6-89a6-a2754e64d254\",\n \"gifts\": [\n {\n \"id\": 424941699,\n \"value\": 50,\n \"name\": \"Uri\",\n \"email\": \"uri@rise.ai\",\n \"message\": \"Uri U'r amazing, Love u ;)\",\n \"sending_method\": \"email\",\n \"image\": \"https://assets.rise-ai.com/static/02b2b9cf1ed84edb8fa64cb1799fdd346865793278584a72bbb81d3fb951d413.jpg\",\n \"send_at\": \"2021-03-04T12:43:10.000Z\"\n },\n {\n \"id\": 514063805,\n \"value\": 100,\n \"name\": \"Adi\",\n \"email\": \"adi@rise.ai\",\n \"message\": \"Adi U'r amazing, Love u ;)\",\n \"sending_method\": \"email\",\n \"image\": \"https://assets.rise-ai.com/static/02b2b9cf1ed84edb8fa64cb1799fdd346865793278584a72bbb81d3fb951d413.jpg\",\n \"send_at\": \"2021-03-04T12:43:10.000Z\"\n }\n ]\n }\n}"}],"_postman_id":"131b51fa-6cd8-4c4e-88e4-643d79028af9"}],"id":"2c3c4cd1-6607-4bd3-aee4-c283cd8ea20a","_postman_id":"2c3c4cd1-6607-4bd3-aee4-c283cd8ea20a","description":""},{"name":"Gift","item":[{"name":"Create Gift","id":"626debcd-e398-47d4-a5d7-8174481f83ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-rise-gifting-api-key","value":"XXXX-XXXX-XXXX-XXXX","description":"Rise.ai API access token
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"gift\": {\n \"value\": 100,\n \"variant_id\": \"40855118053436\",\n \"name\": \"Adi\",\n \"email\": \"adi@rise.ai\",\n \"message\": \"Adi U'r amazing, Love u ;)\",\n \"sending_method\": \"email\",\n \"image\": \"https://assets.rise-ai.com/static/02b2b9cf1ed84edb8fa64cb1799fdd346865793278584a72bbb81d3fb951d413.jpg\",\n \"send_at\": \"2021-03-04T12:43:10.000Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://application.rise-ai.com/integrations/inbound/gifting/session/:session_id?shop_url=amazingshop.myshopify.com","urlObject":{"protocol":"https","path":["integrations","inbound","gifting","session",":session_id"],"host":["application","rise-ai","com"],"query":[{"description":{"content":"The Shopify shop domain
\n","type":"text/plain"},"key":"shop_url","value":"amazingshop.myshopify.com"}],"variable":[{"description":{"content":"The recevied session id
\n","type":"text/plain"},"type":"any","value":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","key":"session_id"}]}},"response":[{"id":"f98be585-12f1-4e8a-b181-79153d4877d6","name":"Create Gift","originalRequest":{"method":"POST","header":[{"key":"x-rise-gifting-api-key","value":"XXXX-XXXX-XXXX-XXXX","description":"Rise.ai API access token","type":"text"}],"body":{"mode":"raw","raw":"{\n \"gift\": {\n \"value\": 50,\n \"name\": \"Uri\",\n \"email\": \"uri@rise.ai\",\n \"message\": \"Uri U'r amazing, Love u ;)\",\n \"sending_method\": \"email\",\n \"image\": \"https://assets.rise-ai.com/static/02b2b9cf1ed84edb8fa64cb1799fdd346865793278584a72bbb81d3fb951d413.jpg\",\n \"send_at\": \"2021-03-04T12:43:10.000Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://application.rise-ai.com/integrations/inbound/gifting/session/d50c6478-2095-47f6-89a6-a2754e64d254"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 12 Apr 2021 11:26:49 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"285"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"11d-NjHuFiGp8WzI/ci5nUq6vXLURz4\""},{"key":"Set-Cookie","value":"rise_gifting_session=j%3A%7B%22session%22%3A%7B%22id%22%3A%22d50c6478-2095-47f6-89a6-a2754e64d254%22%7D%7D; Path=/; Expires=Mon, 26 Apr 2021 11:26:49 GMT; Secure"},{"key":"X-Powered-By","value":"Express"},{"key":"X-Rise-Api-Bucket-Consumed","value":"1"},{"key":"X-Rise-Api-Bucket-Limit","value":"40"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"cf-request-id","value":"09676ea149000040ead910c000000001"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report?s=KyL9hn%2BQFMmubNw5cqXNvoQb2UQM%2B4GkuiiDOYClc3X6jV5HgSRYU8GyB5KwIpjCpQ5sAVUb8gcLnzw1W6Iwj%2BNI4GlfYv5VTOB4in36m0CU%2FDNFudjli9Bmk7itKA%3D%3D\"}]}"},{"key":"NEL","value":"{\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"63ec1a154b9140ea-LHR"}],"cookie":[],"responseTime":null,"body":"{\n \"gift\": {\n \"id\": 950146482,\n \"variant_id\": \"40855118053436\",\n \"value\": 50,\n \"name\": \"Uri\",\n \"email\": \"uri@rise.ai\",\n \"message\": \"Uri U'r amazing, Love u ;)\",\n \"sending_method\": \"email\",\n \"image\": \"https://assets.rise-ai.com/static/02b2b9cf1ed84edb8fa64cb1799fdd346865793278584a72bbb81d3fb951d413.jpg\",\n \"send_at\": \"2021-03-04T12:43:10.000Z\"\n }\n}"}],"_postman_id":"626debcd-e398-47d4-a5d7-8174481f83ec"},{"name":"Update Gift","id":"7e583926-4777-4368-bdc3-c37c4714995e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"x-rise-gifting-api-key","value":"XXXX-XXXX-XXXX-XXXX","description":"Rise.ai API access token
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"gift\": {\n \"value\": 125,\n \"name\": \"Adi\",\n \"sending_method\": \"sms\",\n \"send_at\": \"2021-03-15T18:00:00.000Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://application.rise-ai.com/integrations/inbound/gifting/session/:session_id/gift/:gift_id?shop_url=amazingshop.myshopify.com","urlObject":{"protocol":"https","path":["integrations","inbound","gifting","session",":session_id","gift",":gift_id"],"host":["application","rise-ai","com"],"query":[{"description":{"content":"The Shopify shop domain
\n","type":"text/plain"},"key":"shop_url","value":"amazingshop.myshopify.com"}],"variable":[{"description":{"content":"The recevied session id
\n","type":"text/plain"},"type":"any","value":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","key":"session_id"},{"description":{"content":"The gift id
\n","type":"text/plain"},"type":"any","value":"12345678901234","key":"gift_id"}]}},"response":[{"id":"381809b7-8643-4cbf-9030-508812443fcc","name":"Update Gift","originalRequest":{"method":"PUT","header":[{"key":"x-rise-gifting-api-key","value":"XXXX-XXXX-XXXX-XXXX","description":"Rise.ai API access token","type":"text"}],"body":{"mode":"raw","raw":"{\n \"gift\": {\n \"value\": 125,\n \"name\": \"Adi\",\n \"sending_method\": \"sms\",\n \"send_at\": \"2021-03-15T18:00:00.000Z\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://application.rise-ai.com/integrations/inbound/gifting/session/d50c6478-2095-47f6-89a6-a2754e64d254/gift/950146482"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 12 Apr 2021 11:29:29 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"11c-GzTpt0PukyDeWs5kE6iMYoj3FVk\""},{"key":"Set-Cookie","value":"rise_gifting_session=j%3A%7B%22session%22%3A%7B%22id%22%3A%22d50c6478-2095-47f6-89a6-a2754e64d254%22%7D%7D; Path=/; Expires=Mon, 26 Apr 2021 11:29:29 GMT; Secure"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"Express"},{"key":"X-Rise-Api-Bucket-Consumed","value":"1"},{"key":"X-Rise-Api-Bucket-Limit","value":"40"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"cf-request-id","value":"096771131e000040eab8b05000000001"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report?s=P5%2BNVD%2BfnoAkRlq0v1fsBfE9pExnFLGuV3ykSKLYi3cFpc%2BPceGonRhYagLJ5%2FaAkunffokhV9NIAq%2BKVZKQiai%2F3kvYED%2FpkiDCDvecIRQMsmnVoepcGbGUDFAt6Q%3D%3D\"}]}"},{"key":"NEL","value":"{\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"63ec1dfe9a1540ea-LHR"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"gift\": {\n \"id\": 950146482,\n \"value\": 125,\n \"name\": \"Adi\",\n \"email\": \"uri@rise.ai\",\n \"message\": \"Uri U'r amazing, Love u ;)\",\n \"sending_method\": \"sms\",\n \"image\": \"https://assets.rise-ai.com/static/02b2b9cf1ed84edb8fa64cb1799fdd346865793278584a72bbb81d3fb951d413.jpg\",\n \"send_at\": \"2021-03-15T18:00:00.000Z\"\n }\n}"}],"_postman_id":"7e583926-4777-4368-bdc3-c37c4714995e"},{"name":"Delete Gift","id":"5899972c-e5e6-4a4b-af70-a880691359f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-rise-gifting-api-key","value":"XXXX-XXXX-XXXX-XXXX","description":"Rise.ai API access token
\n","type":"text"}],"url":"https://application.rise-ai.com/integrations/inbound/gifting/session/:session_id/gift/:gift_id?shop_url=amazingshop.myshopify.com","urlObject":{"protocol":"https","path":["integrations","inbound","gifting","session",":session_id","gift",":gift_id"],"host":["application","rise-ai","com"],"query":[{"description":{"content":"The Shopify shop domain
\n","type":"text/plain"},"key":"shop_url","value":"amazingshop.myshopify.com"}],"variable":[{"description":{"content":"The recevied session id
\n","type":"text/plain"},"type":"any","value":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","key":"session_id"},{"description":{"content":"The gift id
\n","type":"text/plain"},"type":"any","value":"12345678901234","key":"gift_id"}]}},"response":[{"id":"beda9ac8-fc6c-44a7-a601-c9f600ca7ded","name":"Delete Gift","originalRequest":{"method":"DELETE","header":[{"key":"x-rise-gifting-api-key","value":"XXXX-XXXX-XXXX-XXXX","description":"Rise.ai API access token","type":"text"}],"url":"https://application.rise-ai.com/integrations/inbound/gifting/session/d50c6478-2095-47f6-89a6-a2754e64d254/gift/950146482"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 12 Apr 2021 11:31:25 GMT"},{"key":"Content-Type","value":"text/plain; charset=utf-8"},{"key":"Content-Length","value":"2"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"2-nOO9QiTIwXgNtWtBJezz8kv3SLc\""},{"key":"Set-Cookie","value":"rise_gifting_session=j%3A%7B%22session%22%3A%7B%22id%22%3A%22d50c6478-2095-47f6-89a6-a2754e64d254%22%7D%7D; Path=/; Expires=Mon, 26 Apr 2021 11:31:25 GMT; Secure"},{"key":"X-Powered-By","value":"Express"},{"key":"X-Rise-Api-Bucket-Consumed","value":"1"},{"key":"X-Rise-Api-Bucket-Limit","value":"40"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"cf-request-id","value":"096772d8c3000040eadd331000000001"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"max_age\":604800,\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report?s=zWKLnwRpEG7fzVor7BGU23FYboH7gRgjtyalYyH58aNbUVkYWK4ozU5hLea1EN4g4gJIIHIlwhNRh3lHHYj0Db2D8tfD8zYmCRJSqtYDlsW8RZ%2BLMBivWjoVG6Bunw%3D%3D\"}]}"},{"key":"NEL","value":"{\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"63ec20d46f1a40ea-LHR"}],"cookie":[],"responseTime":null,"body":"OK"}],"_postman_id":"5899972c-e5e6-4a4b-af70-a880691359f2"}],"id":"5e97832c-6dd1-496c-a581-5a37556758c1","_postman_id":"5e97832c-6dd1-496c-a581-5a37556758c1","description":""},{"name":"Get Assets","id":"caa10090-74ef-4f0c-bde8-2f590fdafe3d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-rise-access-token","value":"XXXX-XXXX-XXXX-XXXX","description":"Rise.ai API access token
\n","type":"text"}],"url":"https://application.rise-ai.com/integrations/inbound/gifting/assets?shop_url=amazingshop.myshopify.com","description":"GET all images selected for the \"pop-up\" asset. \nImages are selected through the Rise.ai dashboard.
\n","urlObject":{"protocol":"https","path":["integrations","inbound","gifting","assets"],"host":["application","rise-ai","com"],"query":[{"description":{"content":"The Shopify shop domain
\n","type":"text/plain"},"key":"shop_url","value":"amazingshop.myshopify.com"}],"variable":[]}},"response":[{"id":"7500c525-c798-4938-b97e-27b79f6c99e7","name":"Get Assets","originalRequest":{"method":"GET","header":[{"key":"x-rise-access-token","value":"XXXX-XXXX-XXXX-XXXX","description":"Rise.ai API access token","type":"text"}],"url":{"raw":"https://application.rise-ai.com/integrations/inbound/gifting/assets?shop_url=amazingshop.myshopify.com","protocol":"https","host":["application","rise-ai","com"],"path":["integrations","inbound","gifting","assets"],"query":[{"key":"shop_url","value":"amazingshop.myshopify.com"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 21 Mar 2021 12:16:56 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"8d-uBofTJluAYV0a5jI8HQ8/oz6F2s\""},{"key":"X-Powered-By","value":"Express"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"cf-request-id","value":"08f650999d000053f17c9da000000001"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"Report-To","value":"{\"group\":\"cf-nel\",\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report?s=cG8y%2BmxL6Sg%2BbU6vlF8sedKeFtaniqLAR2%2FiZG4TQrxkzJutQjJubygPsXGAfQte8dv2DdT6VEUK0XEXocVWF42rJlU7hubSElMpdf3U9fbiOTKPUWItCprpxrYHPw%3D%3D\"}],\"max_age\":604800}"},{"key":"NEL","value":"{\"max_age\":604800,\"report_to\":\"cf-nel\"}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"63371d3c2cba53f1-LHR"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"assets\": {\n \"gallery_images_urls\": [\n \"https://assets.rise-ai.com/static/02b2b9cf1ed84edb8fa64cb1799fdd346865793278584a72bbb81d3fb951d413.jpg\"\n ]\n }\n}"}],"_postman_id":"caa10090-74ef-4f0c-bde8-2f590fdafe3d"}],"id":"d3d70d8f-4f05-4b84-9f39-26966df254af","_postman_id":"d3d70d8f-4f05-4b84-9f39-26966df254af","description":""}],"id":"a7a0cbbb-f3a0-4919-8824-5591b0a98fb9","description":"The REST Gifting API allows you to create your own custom front end gifting modules as well as enable gift selling on whatever platform your store is based on (as long as you use the Shopify checkout). With the Gifting API you will no longer be limited to thenative Rise.ai modules.
\n\nIn order to start using this API you'll need to receive your gifting_api_key. Send an email to dev@rise.ai / your dedicated account manager and we will assist you.
In order to generate access token, use client_secret as explained in the method guidelines
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client_id\": \"your_client_id\",\n \"scheme\": {\n \"variables\": [\n {\n \"path\": \"customer_email\",\n \"type\": \"Email\",\n \"title\": \"Customer Email\"\n }\n ],\n \"meta\": {\n \"title\": \"Tech Partner Trigger\",\n \"description\": \"This is an example of a Custom Trigger made by a Tech Partner\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://workflows.rise-ai.com/triggers?shop_url=amazingshop.myshopify.com","description":"Create a Custom Trigger as a tech partner.
\nEvery tech partner will be provided with a client_id and client_secret (that will be saved in our DB.)
\n{\"shop_url\": \"amazingshop.myshopify.com\"}. The JWT value should be used as the Bearer token in the Authorization header. Make sure to encode the same shop url as the one you put in the request's query paramTrigger Scheme guidelines:
\nmeta - An object containing some general info about the trigger: title and descriptionvariables - A list of the Trigger's fields, defined by 3 propertiestitle - A display name of the variabletype - Defines the allowed value of the variable. It can be one of: 'Boolean', 'Float', 'Date', 'CommaSeparatedString', 'String', 'Email'path - The exact path to the variable, as it's defined in the structure that will be sent to Rise's Trigger systemThe shop URL for which the trigger should be created
\n","type":"text/plain"},"key":"shop_url","value":"amazingshop.myshopify.com"}],"variable":[]}},"response":[{"id":"42f924d0-38e7-4d35-b753-b756478680c0","name":"Create Custom Trigger - Tech partner","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer encoded_shop_url","description":"In order to generate access token, use client_secret as explained in the method guidelines","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client_id\": \"your_client_id\",\n \"scheme\": {\n \"variables\": [\n {\n \"path\": \"customer_email\",\n \"type\": \"Email\",\n \"title\": \"Customer Email\"\n }\n ],\n \"meta\": {\n \"title\": \"Tech Partner Trigger\",\n \"description\": \"This is an example of a Custom Trigger made by a Tech Partner\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://workflows.rise-ai.com/triggers?shop_url=amazingshop.myshopify.com","protocol":"https","host":["workflows","rise-ai","com"],"path":["triggers"],"query":[{"key":"shop_url","value":"amazingshop.myshopify.com","description":"The shop URL for which the trigger should be created"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"trigger\": \"your_trigger_id\",\n \"reqUrl\": \"https://workflows.rise-ai.com/execute/your_trigger_id\"\n}"}],"_postman_id":"147efb58-c054-4da9-a58a-47679b185530"},{"name":"Custom Trigger Execution Example","id":"919688f3-43cf-414f-b866-db709824088f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"customer_email\": \"example@email.com\",\n \"first_name\": \"example\"\n}","options":{"raw":{"language":"json"}}},"url":"https://workflows.rise-ai.com/execute/:trigger_id","description":"Initiates a custom trigger, and processes it upon any using workflows.
\nIn order for a trigger to be processed, the request payload must match the Trigger's scheme.
\n","urlObject":{"protocol":"https","path":["execute",":trigger_id"],"host":["workflows","rise-ai","com"],"query":[],"variable":[{"description":{"content":"The trigger ID as received from the server upon creation
\n","type":"text/plain"},"type":"any","value":"4e6e96a2-f7be-4b83-8015-00f9bae4a92f","key":"trigger_id"}]}},"response":[],"_postman_id":"919688f3-43cf-414f-b866-db709824088f"}],"id":"b59d7253-22bd-45f2-98e6-eab11c2111f2","description":"Loyalty workflows are the easiet way to offer store-credit rewards to your loyal customers. Workflows are highly customizable and can serve any re-engagement purpose you require. You can read more about workflows here: https://help.rise.ai/en/articles/4002969-create-store-credit-loyalty-workflows
\nCustom-triggers are offering developers and tech partners the opportunity to extend workflow triggers to endless use-cases. All that is required is to setup the custom-trigger on your dashboard and integrate the HTTP request like described below.
\n","_postman_id":"b59d7253-22bd-45f2-98e6-eab11c2111f2"}],"event":[{"listen":"prerequest","script":{"id":"1ce70de1-bb9b-42fd-a438-9ad84072f71d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2aad6764-0162-4333-a364-42f176ff2fb0","type":"text/javascript","exec":[""]}}]}