cancel
Showing results for 
Search instead for 
Did you mean: 
Reply
ErickDiaz
Resolver I
Resolver I

How to Specify a Raw Body on a Custom Connector instead of JSON?

Hi,

 

I’m creating a Flow process that uses a custom connector to access an on-prem API using the data gateway. I’m on the first step process to get the access token, the POST method expects a raw body as follow:

 

grant_type=password&username=myusername123&password=mypassword123&scope=api

 

Unfortunately, the custom connector only allows me to define the body in a JSON format so my connector is failing because of the body:

 

{
"grant_type" : "password",
"username" : "myusername123",
"password" : "mypassword123",
"scope" : "api"
}

 

When testing the custom connector, there is an option that let’s me specify a raw body and the test is successful.

 

Custom Connector - JSON Body Failed 400:

Custom Connector - JSON Body Failed 400.jpg

 

Custom Connector - Raw Body Succeeded 200:

Custom Connector - Raw Body Succeeded 200.jpg

 

However, when I create my flow, I do not have the option to pass the body as raw:

 

Flow - Cannot Specify Raw Body Option.jpg

 

Any idea how to pass a raw body to my custom connector?

 

Thank you,

 

Erick

12 REPLIES 12
maneesh
Regular Visitor

@HEATFreight I am literally in the same boat as you are.

Canvas app just won't pass body to the custom connector no matter what.

Sigh! Did you find it to work?

@maneesh  Well, no I did not get the custom connector working with the API I was having trouble with, but I've made huge progress and I did get a custom connector working perfectly with the QuickBooks Online API.

First, I'll say that custom connectors are janky. There are bugs. I prefer using the Swagger Editor that's built into the custom connector interface. I refuse to use the basic custom connector editor interface because it causes things to break which would otherwise work with the Swagger Editor. I import a Postman v2.1 collection to build the custom connector. I save from the >Security tab after inputting all the OAuth2 credentials and before moving on to the >Definition tab. And in the >Definition tab I make no changes at all except while the Swagger Editor toggled on.

Here is the guide I followed
^^the above link is broken, here's a wayback link


The biggest lesson learned is that you should probably be using OAuth2 in the Postman >Authorization tab, assuming the API you're using works with OAuth2. My first attempt at building a custom connector was for a 3rd party API, call it Example.com, which allows both the password grant type and the auth code grant type. The password grant type is simpler for an API novice to work with, but I don't think there is any easy way to make the password grant type authorization flow work within the custom connector. So that was the crux of my issues on the first attempt. I was probably doing it wrong, so I'm not sure that the empty request body parameter issue was really the root of the problem.

The secret is OAuth2 works automatically in the background of the custom connector. If you do it right, you do not have to hard code any authorization/authentication/refresh requests manually. In Postman, you will need to manually build a separate request outside of your collection to refresh your access token, since Postman has no functionality to keep it refreshed automatically. Put the important bit is, if you want to try this OAuth2 thing, you don't need to import any auth/refresh requests into the custom connector. Custom connectors make those requests for you in the background. There is something called the "OAuth2 authorization code flow" which consists of at least one GET request and two POST requests, followed later by another POST request once access token has expired. The GET-POST-POST sequence basically redirects user to a login page for the API, where they input username and password, then it returns an authorization code which is used to request an access token. Along with the access token, you of course get a refresh token and expiration time.

So whenever you click "New connection" in the >Test tab of custom connector, or if your user tries to run the Power App and is prompted to create their own connection, the custom connector automatically runs that sequence of requests called the auth code flow. So you automatically get redirected to the login page, and submitting the login credentials automatically produces your tokens, and the custom connector automatically parses the response body to store those token properties for later use, and finally once the access token expires the custom connector automatically refreshes the token. I used to think I would have to manually build the GET-POST-POST sequence for the auth code flow, as well as the later POST request that keeps the token refreshed. But that's not true. DO NOT MANUALLY BUILD THESE REQUESTS. Postman does them for you and the custom connector will as well. If you do try to replicate those request manually, do so in a separate collection from the one you plan to import into the custom connector. You will need to manually build the refresh token request in Postman if you want to keep the token refreshed while testing in Postman, but keep it separate from the collection you plan to export. The collection you will export should be just the normal API requests, like POST Invoice-Create or GET Customer-ReadByID (to borrow examples from the QuickBooks Online API). Each of those requests should have OAuth2 authorization option (Postman's inherit auth from parent option won't work when you export the Postman collection and import to custom connector, so each request has to have that OAuth2 setting set explicitly). Most of the rest of the OAuth2 settings in Postman will not import to the custom connector, so you will have to reenter those values in the >Security tab of the custom connector (like client ID, client secret, token URL, refresh URL, and scope).

Anyway, so I was able to get the QuickBooks Online API working perfectly, and it keeps itself refreshed. Access token expires after one hour, but my QuickBooks Online API custom connector has stayed connected for a few weeks now and is still going strong. I can't say the same for that "Example.com" API. Now that I've successfully got the QBO API working in a custom connector, I thought "why not try to replicate this with the API that was giving me trouble before?"

Well that "Example.com" API (not really example.com...) seems to be breaking the custom connector due to a triple-slash-escaped JSON-formatted string included in an extra response property of that API. The QBO API does not have anything like that in its response, and it works perfectly. "Example.com" works perfectly as a custom connector for 20 minutes, then the access token expires and it fails to refresh. I think it fails because Swagger Editor regards triple-backslash as a comment line, so I believe that custom response property in the "Example.com" API is breaking the custom connector. Microsoft support ticket still open with no resolution. So, I've abandoned "Example.com" as a custom connector for now. It's just not compatible. I have it deployed using the resource owner password grant type in a series of Power Automate flows. It's clunkier and more difficult to build, use, debug, and edit than a custom connector, and probably has higher latency, but it works.

Moral of the story is: if you're still stuck on passing in an empty request body property to the custom connector from Power Apps, you may have a similar situation as me. You may benefit from using the OAuth2 auth code flow to have custom connector automate the token generation and refresh process for you.

Now technically I don't think I've tested a fully functional custom connector with an empty request body from Power Apps again yet, so all of this may be totally irrelevant to the issue you are having.

Suffice it to say that, when custom connectors work, they work beautifully and are really, really, really easy to configure. Like, if it's not working for you, it could be some incompatibility like what I encountered with "Example.com" API. For me, following that guide I linked to above made the QBO API mind-blowingly simple to deploy in a custom connector. Try following that QBO guide for the API you're working with, or if you have a QuickBooks Online account, try building a QBO API custom connector. If you can get that working, it will be a lot easier to understand what's going on with your other API. For me it made all the difference. I wasn't successful at deploying "Example.com" in a custom connector, but I did find a bug that has stumped the Microsoft product managers. I wouldn't have understood everything at the level I do now had I not found that QBO custom connector guide.

Here is a thread where I go into great depth about the two APIs I'm working with, one that works gre...


Edit: Wow, typing out this response made me consider doing something I haven't tried yet: OAuth2 Authorization type with grant type set to "password credentials". I have successfully manually built the auth request for the password grant type, and I have tried importing the manually built authorization and refresh requests for that password grant type into the custom connector (doesn't work at all), but I have not tried using the OAuth2 settings to get the custom connector to run the auth/refresh requests for me, without me having to manually build them in the collection. Oh but I just realized that won't work because the triple-backslash escape character from the "Example.com" API response body property will still cause the same bug that prevents the custom connector from parsing the response body and storing the refresh token, so no matter which grant type I use, the custom connector will fail to refresh the token for this particular API. My Power Automate solution works fine for now, so will stick with that until a better solution presents itself...

Facing a similar issue, Do we have any workaround for this? In my case, I have created a custom connector but by default it is hitting with an empty json body like '{}' but I have to pass the raw body as empty then only the API will work!

Helpful resources

Announcements

Exclusive LIVE Community Event: Power Apps Copilot Coffee Chat with Copilot Studio Product Team

  It's time for the SECOND Power Apps Copilot Coffee Chat featuring the Copilot Studio product team, which will be held LIVE on April 3, 2024 at 9:30 AM Pacific Daylight Time (PDT).     This is an incredible opportunity to connect with members of the Copilot Studio product team and ask them anything about Copilot Studio. We'll share our special guests with you shortly--but we want to encourage to mark your calendars now because you will not want to miss the conversation.   This live event will give you the unique opportunity to learn more about Copilot Studio plans, where we’ll focus, and get insight into upcoming features. We’re looking forward to hearing from the community, so bring your questions!   TO GET ACCESS TO THIS EXCLUSIVE AMA: Kudo this post to reserve your spot! Reserve your spot now by kudoing this post.  Reservations will be prioritized on when your kudo for the post comes through, so don't wait! Click that "kudo button" today.   Invitations will be sent on April 2nd.Users posting Kudos after April 2nd. at 9AM PDT may not receive an invitation but will be able to view the session online after conclusion of the event. Give your "kudo" today and mark your calendars for April 3rd, 2024 at 9:30 AM PDT and join us for an engaging and informative session!

Tuesday Tip: Unlocking Community Achievements and Earning Badges

TUESDAY TIPS are our way of communicating helpful things we've learned or shared that have helped members of the Community. Whether you're just getting started or you're a seasoned pro, Tuesday Tips will help you know where to go, what to look for, and navigate your way through the ever-growing--and ever-changing--world of the Power Platform Community! We cover basics about the Community, provide a few "insider tips" to make your experience even better, and share best practices gleaned from our most active community members and Super Users.   With so many new Community members joining us each week, we'll also review a few of our "best practices" so you know just "how" the Community works, so make sure to watch the News & Announcements each week for the latest and greatest Tuesday Tips!     THIS WEEK'S TIP: Unlocking Achievements and Earning BadgesAcross the Communities, you'll see badges on users profile that recognize and reward their engagement and contributions. These badges each signify a different achievement--and all of those achievements are available to any Community member! If you're a seasoned pro or just getting started, you too can earn badges for the great work you do. Check out some details on Community badges below--and find out more in the detailed link at the end of the article!       A Diverse Range of Badges to Collect The badges you can earn in the Community cover a wide array of activities, including: Kudos Received: Acknowledges the number of times a user’s post has been appreciated with a “Kudo.”Kudos Given: Highlights the user’s generosity in recognizing others’ contributions.Topics Created: Tracks the number of discussions initiated by a user.Solutions Provided: Celebrates the instances where a user’s response is marked as the correct solution.Reply: Counts the number of times a user has engaged with community discussions.Blog Contributor: Honors those who contribute valuable content and are invited to write for the community blog.       A Community Evolving Together Badges are not only a great way to recognize outstanding contributions of our amazing Community members--they are also a way to continue fostering a collaborative and supportive environment. As you continue to share your knowledge and assist each other these badges serve as a visual representation of your valuable contributions.   Find out more about badges in these Community Support pages in each Community: All About Community Badges - Power Apps CommunityAll About Community Badges - Power Automate CommunityAll About Community Badges - Copilot Studio CommunityAll About Community Badges - Power Pages Community

Tuesday Tips: Powering Up Your Community Profile

TUESDAY TIPS are our way of communicating helpful things we've learned or shared that have helped members of the Community. Whether you're just getting started or you're a seasoned pro, Tuesday Tips will help you know where to go, what to look for, and navigate your way through the ever-growing--and ever-changing--world of the Power Platform Community! We cover basics about the Community, provide a few "insider tips" to make your experience even better, and share best practices gleaned from our most active community members and Super Users.   With so many new Community members joining us each week, we'll also review a few of our "best practices" so you know just "how" the Community works, so make sure to watch the News & Announcements each week for the latest and greatest Tuesday Tips!   This Week's Tip: Power Up Your Profile!  🚀 It's where every Community member gets their start, and it's essential that you keep it updated! Your Community User Profile is how you're able to get messages, post solutions, ask questions--and as you rank up, it's where your badges will appear and how you'll be known when you start blogging in the Community Blog. Your Community User Profile is how the Community knows you--so it's essential that it works the way you need it to! From changing your username to updating contact information, this Knowledge Base Article is your best resource for powering up your profile.     Password Puzzles? No Problem! Find out how to sync your Azure AD password with your community account, ensuring a seamless sign-in. No separate passwords to remember! Job Jumps & Email Swaps Changed jobs? Got a new email? Fear not! You'll find out how to link your shiny new email to your existing community account, keeping your contributions and connections intact. Username Uncertainties Unraveled Picking the perfect username is crucial--and sometimes the original choice you signed up with doesn't fit as well as you may have thought. There's a quick way to request an update here--but remember, your username is your community identity, so choose wisely. "Need Admin Approval" Warning Window? If you see this error message while using the community, don't worry. A simple process will help you get where you need to go. If you still need assistance, find out how to contact your Community Support team. Whatever you're looking for, when it comes to your profile, the Community Account Support Knowledge Base article is your treasure trove of tips as you navigate the nuances of your Community Profile. It’s the ultimate resource for keeping your digital identity in tip-top shape while engaging with the Power Platform Community. So, dive in and power up your profile today!  💪🚀   Community Account Support | Power Apps Community Account Support | Power AutomateCommunity Account Support | Copilot Studio  Community Account Support | Power Pages

Super User of the Month | Chris Piasecki

In our 2nd installment of this new ongoing feature in the Community, we're thrilled to announce that Chris Piasecki is our Super User of the Month for March 2024. If you've been in the Community for a while, we're sure you've seen a comment or marked one of Chris' helpful tips as a solution--he's been a Super User for SEVEN consecutive seasons!       Since authoring his first reply in April 2020 to his most recent achievement organizing the Canadian Power Platform Summit this month, Chris has helped countless Community members with his insights and expertise. In addition to being a Super User, Chris is also a User Group leader, Microsoft MVP, and a featured speaker at the Microsoft Power Platform Conference. His contributions to the new SUIT program, along with his joyous personality and willingness to jump in and help so many members has made Chris a fixture in the Power Platform Community.   When Chris isn't authoring solutions or organizing events, he's actively leading Piasecki Consulting, specializing in solution architecture, integration, DevOps, and more--helping clients discover how to strategize and implement Microsoft's technology platforms. We are grateful for Chris' insightful help in the Community and look forward to even more amazing milestones as he continues to assist so many with his great tips, solutions--always with a smile and a great sense of humor.You can find Chris in the Community and on LinkedIn. Thanks for being such a SUPER user, Chris! 💪🌠

Find Out What Makes Super Users So Super

We know many of you visit the Power Platform Communities to ask questions and receive answers. But do you know that many of our best answers and solutions come from Community members who are super active, helping anyone who needs a little help getting unstuck with Business Applications products? We call these dedicated Community members Super Users because they are the real heroes in the Community, willing to jump in whenever they can to help! Maybe you've encountered them yourself and they've solved some of your biggest questions. Have you ever wondered, "Why?"We interviewed several of our Super Users to understand what drives them to help in the Community--and discover the difference it has made in their lives as well! Take a look in our gallery today: What Motivates a Super User? - Power Platform Community (microsoft.com)

March User Group Update: New Groups and Upcoming Events!

  Welcome to this month’s celebration of our Community User Groups and exciting User Group events. We’re thrilled to introduce some brand-new user groups that have recently joined our vibrant community. Plus, we’ve got a lineup of engaging events you won’t want to miss. Let’s jump right in: New User Groups   Sacramento Power Platform GroupANZ Power Platform COE User GroupPower Platform MongoliaPower Platform User Group OmanPower Platform User Group Delta StateMid Michigan Power Platform Upcoming Events  DUG4MFG - Quarterly Meetup - Microsoft Demand PlanningDate: 19 Mar 2024 | 10:30 AM to 12:30 PM Central America Standard TimeDescription: Dive into the world of manufacturing with a focus on Demand Planning. Learn from industry experts and share your insights. Dynamics User Group HoustonDate: 07 Mar 2024 | 11:00 AM to 01:00 PM Central America Standard TimeDescription: Houston, get ready for an immersive session on Dynamics 365 and the Power Platform. Connect with fellow professionals and expand your knowledge. Reading Dynamics 365 & Power Platform User Group (Q1)Date: 05 Mar 2024 | 06:00 PM to 09:00 PM GMT Standard TimeDescription: Join our virtual meetup for insightful discussions, demos, and community updates. Let’s kick off Q1 with a bang! Leaders, Create Your Events!    Leaders of existing User Groups, don’t forget to create your events within the Community platform. By doing so, you’ll enable us to share them in future posts and newsletters. Let’s spread the word and make these gatherings even more impactful! Stay tuned for more updates, inspiring stories, and collaborative opportunities from and for our Community User Groups.   P.S. Have an event or success story to share? Reach out to us – we’d love to feature you!

Users online (6,234)