cancel
Showing results for 
Search instead for 
Did you mean: 
Reply
rekodus
Regular Visitor

Custom Connector for Asynchronous Function

I am trying to build and use a custom connector to call an asynchronous function that is hosted in Azure Function Services. The asynchronous functions returns HTTP 202 accepted and the URL of another function in the same API that can be polled for the status and the final result. It works as intended when I call this function with an HTTP connector but called with a custom connector MS Flow cannot access the of status function and returns HTTP 404 resource not found. I guess this is related to the fact that MS Flow does not call custom connectors directly but via a proxy. Any ideas on how to solve this?

 

=========================================

Async function:

module.exports = function (context, req) {
   context.res = {
      status: 202,
         headers: {
              "location": "https://xxx.azurewebsites.net/api/getStatus?code=XXX",
               "retry-after": 10
         },
      body: { result: "try again!"}
};
context.done();
};
====================================================
getStatus:
module.exports = function (context, req) {
   context.res = {
      status: 200,
      body: { result: { import_status: "done", msg: "Oh yeah, this is the result" } }
   };
  context.done();
};
10 REPLIES 10
v-yuazh-msft
Community Support
Community Support

Hi @rekodus,

 

Have you found the solution to achieve your requirement?

 

Best regards,

Alice

marcchasse
Frequent Visitor

@rekodus @v-yuazh-msft I'm a few years late but this was the top result so hopefully my solution helps others.


Custom Connectors use an APIM Proxy, and the response location header ends up getting re-written with the APIM endpoint. So even though your function app is returning a 202 with the location header properly set the custom connector re-writes that to use the APIM proxy. When you enable the async pattern on the action in a flow Power Automate will try to call that transformed location header and I'm guessing since it's a different endpoint the APIM returns a 404.

To test this out I created a C# function app to mock out the async pattern:

[FunctionName("Start")]
public static async Task<IActionResult> Start([HttpTrigger(AuthorizationLevel.Anonymous, "get", "post", Route = null)] HttpRequest req, ILogger log)
{
    return new AcceptedResult($"{req.Scheme}://{req.Host}/api/Status", "Please Hold");
}

[FunctionName("Status")]
public static async Task<IActionResult> Status([HttpTrigger(AuthorizationLevel.Anonymous, "get", "post", Route = null)] HttpRequest req,ILogger log)
{
    return new OkObjectResult("it worked!");
}

I created a very simple custom connector with no inputs to call the Start method, swagger as follows: 

swagger: '2.0'
info:
  title: Default title
  description: ''
  version: '1.0'
host: <my function app name>.azurewebsites.net
basePath: /api/
schemes:
  - https
consumes: []
produces: []
paths:
  /Start:
    get:
      responses:
        default:
          description: default
          schema: {}
      operationId: Start
      parameters: []
definitions: {}
parameters: {}
responses: {}
securityDefinitions: {}
security: []
tags: []

As described above testing this custom connector shows that the location header is being re-written:

marcchasse_0-1677867511207.png

To fix that I can rewrite the location header back to what it was originally with some Custom Connector Code:

public class Script : ScriptBase
{
    public override async Task<HttpResponseMessage> ExecuteAsync()
    {
        if (this.Context.OperationId == "Start")
        {
            return await this.TransformStartLocationHeader().ConfigureAwait(false);
        }

        return await this.Context.SendAsync(this.Context.Request, this.CancellationToken).ConfigureAwait(false);
    }

    private async Task<HttpResponseMessage> TransformStartLocationHeader()
    {
        HttpResponseMessage response = await this.Context.SendAsync(this.Context.Request, this.CancellationToken).ConfigureAwait(continueOnCapturedContext: false);

        // https://<my function app name>.azurewebsites.net/api/Start
        var OgReqUri = this.Context.Request.RequestUri;

        // https://unitedstates-002.azure-apim.net/apim/dsa-5fdummy-20async-20func-20app-c4e7fc1bf57c4dad25/90fbd47f-7ea1-414e-9719-81e23fc41121/Status
        var BadLoc = response.Headers.Location.ToString();

        // https://<my function app name>.azurewebsites.net/api/Status
        var newLocation = $"{OgReqUri.Scheme}://{OgReqUri.Host}/api/{BadLoc.Split('/').Last()}";

        response.Headers.Location = new Uri(newLocation);
        return response;
    }
}

 

Now with the async pattern turned on for the card the custom connector will return what’s at the endpoint in the location header.

marcchasse_1-1677868117955.png

marcchasse_2-1677868174338.png

 

Note that when we moved this to a function app that required authorization via a query string parameter, we had to add that query string back in the location header for power automate to complete the async pattern without getting a 401.
You also need to use the Azure Function Host key since you'll be talking to two separate functions.

Hope this works for you,

Marc

marcchasse
Frequent Visitor

After some more investigation we found a better way to enable async in custom connectors that does not rely on using custom code.
You need to add the endpoint that is defined in the location header of the 202 response to the swagger definition in the custom connector.
in our case that response is a get request to /PDF2TIF_status/23512243564

marcchasse_0-1678209284182.png

note line 46 specifies this action as internal, which hides it from being used in a flow.
With this approach the power platform will define an endpoint in APIM for your 202 location and instead of receiving a 404 from APIM it will instead forward the request along as expected.
The authentication is also passed along for you so there's no need to forward that as I noted previously.

nirmal_kumar
New Member

Excellent, with this approach people can easily build custom solution similar to "Wait for Approval".

I'm curious to see what do you did on the other endpoint. I'm currently returning a 202 response with the location header as a relative path, but the custom connector just ends as success. what am I missing?

murguiar_0-1707945497258.pngmurguiar_1-1707945615574.pngmurguiar_2-1707945704083.png

 

marcchasse
Frequent Visitor

@murguiar did you enable the async pattern on the custom connector action in your flow?

I certainly did, it's enabled by default. 

murguiar_0-1707946531595.png

 

marcchasse
Frequent Visitor

I only ever tried with an absolute path, I wonder if you can change your endpoint to be an abslute path for testing, ensure its working as expected and then see how the connector works diffrently with a relative path. I found it easier for me was to have my own test endpoint that would just return a hardcoded location and the endpoint in the location would also return a simple 200 "it worked" type response.

the test functionality in the custom connector editor itself seems to provide better information for debugging then a card in a flow too.

Hope it helps,
Marc

Returning an absolute path seems to work, Thanks!

@marcchasse Were you able to find a spec for what the response object schema should be for the resource that get's polled? e.g. is the below correct?

 

 

{
  "status": "Completed",
  "operationId": "12345",
  "result": {
    "data": "Here could be the actual data/result of the operation, such as a download link, operation results, etc.",
    "moreDetails": "Additional details about the operation or results."
  },
  "message": "Your request has been successfully processed."
}

 

 

 

 

Helpful resources

Announcements

Update! June 13th, Community Ambassador Call for User Group Leaders and Super Users

Calling all Super Users & User Group Leaders   UPDATE:  We just wrapped up June's Community Ambassador monthly calls for Super Users and User Group Leaders. We had a fantastic call with lots of engagement. We are excited to share some highlights with you!    Big THANK YOU to our special guest Thomas Verhasselt, from the Copilot Studio Product Team for sharing how to use Power Platform Templates to achieve next generation growth.     A few key takeaways: Copilot Studio Cookbook Challenge:  Week 1 results are posted, Keep up the great work!Summer of Solutions:  Starting on Monday, June 17th. Just by providing solutions in the community, you can be entered to win tickets to Power Platform Community Conference.Super User Season 2: Coming SoonAll communities moving to the new platform end of July We also honored two different community members during the call, Mohamed Amine Mahmoudi and Markus Franz! We are thankful for both leaders' contributions and engagement with their respective communities. 🎉   Be sure to mark your calendars and register for the meeting on July 11th and stay up to date on all of the changes that are coming. Check out the Super User Forum boards for details.   We're excited to connect with you and continue building a stronger community together.   See you at the call!

Copilot Cookbook Challenge | Week 2 Results | Win Tickets to the Power Platform Conference

We are excited to announce the "The Copilot Cookbook Community Challenge is a great way to showcase your creativity and connect with others. Plus, you could win tickets to the Power Platform Community Conference in Las Vegas in September 2024 as an amazing bonus.   Two ways to enter: 1. Copilot Studio Cookbook Gallery:  https://aka.ms/CS_Copilot_Cookbook_Challenge 2. Power Apps Copilot Cookbook Gallery: https://aka.ms/PA_Copilot_Cookbook_Challenge   There will be 5 chances to qualify for the final drawing: Early Bird Entries: March 1 - June 2Week 1: June 3 - June 9Week 2: June 10 - June 16Week 3: June 17 - June 23Week 4: June 24 - June 30     At the end of each week, we will draw 5 random names from every user who has posted a qualifying Copilot Studio template, sample or demo in the Copilot Studio Cookbook or a qualifying Power Apps Copilot sample or demo in the Power Apps Copilot Cookbook. Users who are not drawn in a given week will be added to the pool for the next week. Users can qualify more than once, but no more than once per week. Four winners will be drawn at random from the total qualifying entrants. If a winner declines, we will draw again at random for the next winner.  A user will only be able to win once. If they are drawn multiple times, another user will be drawn at random. Prizes:  One Pass to the Power Platform Conference in Las Vegas, Sep. 18-20, 2024 ($1800 value, does not include travel, lodging, or any other expenses) Winners are also eligible to do a 10-minute presentation of their demo or solution in a community solutions showcase at the event. To qualify for the drawing, templates, samples or demos must be related to Copilot Studio or a Copilot feature of Power Apps, Power Automate, or Power Pages, and must demonstrate or solve a complete unique and useful business or technical problem. Power Automate and Power Pagers posts should be added to the Power Apps Cookbook. Final determination of qualifying entries is at the sole discretion of Microsoft. Weekly updates and the Final random winners will be posted in the News & Announcements section in the communities on July 29th, 2024. Did you submit entries early?  Early Bird Entries March 1 - June 2:  If you posted something in the "early bird" time frame complete this form: https://aka.ms/Copilot_Challenge_EarlyBirds if you would like to be entered in the challenge.   Week 1 Results:  Congratulations to the Week 1 qualifiers, you are being entered in the random drawing that will take place at the end of the challenge. Copilot Cookbook Gallery:Power Apps Cookbook Gallery:1.  @Mathieu_Paris 1.   @SpongYe 2.  @Dhanush 2.   @Deenuji 3.  n/a3.   @Nived_Nambiar  4.  n/a4.   @ManishSolanki 5.  n/a5.    n/a   Week 2 Results:  Congratulations to the Week 2 qualifiers, you are being entered in the random drawing that will take place at the end of the challenge. Copilot Cookbook Gallery:Power Apps Cookbook Gallery:1. Kasun_Pathirana1. ManishSolanki2. cloudatica2. madlad3. n/a3. SpongYe4. n/a4. n/a5. n/a5. n/a

Win free tickets to the Power Platform Conference | Summer of Solutions

We are excited to announce the Summer of Solutions Challenge!    This challenge is kicking off on Monday, June 17th and will run for (4) weeks.  The challenge is open to all Power Platform (Power Apps, Power Automate, Copilot Studio & Power Pages) community members. We invite you to participate in a quest to provide solutions to as many questions as you can. Answers can be provided in all the communities.    Entry Period: This Challenge will consist of four weekly Entry Periods as follows (each an “Entry Period”)   - 12:00 a.m. PT on June 17, 2024 – 11:59 p.m. PT on June 23, 2024 - 12:00 a.m. PT on June 24, 2024 – 11:59 p.m. PT on June 30, 2024 - 12:00 a.m. PT on July 1, 2024 – 11:59 p.m. PT on July 7, 2024 - 12:00 a.m. PT on July 8, 2024 – 11:59 p.m. PT on July 14, 2024   Entries will be eligible for the Entry Period in which they are received and will not carryover to subsequent weekly entry periods.  You must enter into each weekly Entry Period separately.   How to Enter: We invite you to participate in a quest to provide "Accepted Solutions" to as many questions as you can. Answers can be provided in all the communities. Users must provide a solution which can be an “Accepted Solution” in the Forums in all of the communities and there are no limits to the number of “Accepted Solutions” that a member can provide for entries in this challenge, but each entry must be substantially unique and different.    Winner Selection and Prizes: At the end of each week, we will list the top ten (10) Community users which will consist of: 5 Community Members & 5 Super Users and they will advance to the final drawing. We will post each week in the News & Announcements the top 10 Solution providers.  At the end of the challenge, we will add all of the top 10 weekly names and enter them into a random drawing.  Then we will randomly select ten (10) winners (5 Community Members & 5 Super Users) from among all eligible entrants received across all weekly Entry Periods to receive the prize listed below. If a winner declines, we will draw again at random for the next winner.  A user will only be able to win once overall. If they are drawn multiple times, another user will be drawn at random.  Individuals will be contacted before the announcement with the opportunity to claim or deny the prize.  Once all of the winners have been notified, we will post in the News & Announcements of each community with the list of winners.   Each winner will receive one (1) Pass to the Power Platform Conference in Las Vegas, Sep. 18-20, 2024 ($1800 value). NOTE: Prize is for conference attendance only and any other costs such as airfare, lodging, transportation, and food are the sole responsibility of the winner. Tickets are not transferable to any other party or to next year’s event.   ** PLEASE SEE THE ATTACHED RULES for this CHALLENGE**

Celebrating the June Super User of the Month: Markus Franz

Markus Franz is a phenomenal contributor to the Power Apps Community. Super Users like Markus inspire others through their example, encouragement, and active participation.    The Why: "I do this to help others achieve what they are trying to do. As a total beginner back then without IT background I know how overwhelming things can be, so I decided to jump in and help others. I also do this to keep progressing and learning myself." Thank you, Markus Franz, for your outstanding work! Keep inspiring others and making a difference in the community! 🎉  Keep up the fantastic work! 👏👏 Markus Franz | LinkedIn  Power Apps: mmbr1606  

Your Moment to Shine: 2024 PPCC’s Got Power Awards Show

For the third year, we invite you, our talented community members, to participate in the grand 2024 Power Platform Community Conference's Got Power Awards. This event is your opportunity to showcase solutions that make a significant business impact, highlight extensive use of Power Platform products, demonstrate good governance, or tell an inspirational story. Share your success stories, inspire your peers, and show off some hidden talents.  This is your time to shine and bring your creations into the spotlight!  Make your mark, inspire others and leave a lasting impression. Sign up today for a chance to showcase your solution and win the coveted 2024 PPCC’s Got Power Award. This year we have three categories for you to participate in: Technical Solution Demo, Storytelling, and Hidden Talent.      The Technical solution demo category showcases your applications, automated workflows, copilot agentic experiences, web pages, AI capabilities, dashboards, and/or more. We want to see your most impactful Power Platform solutions!  The Storytelling category is where you can share your inspiring story, and the Hidden Talent category is where your talents (such as singing, dancing, jump roping, etc.) can shine! Submission Details:  Fill out the submission form https://aka.ms/PPCCGotPowerSignup by July 12th with details and a 2–5-minute video showcasing your Solution impact. (Please let us know you're coming to PPCC, too!)After review by a panel of Microsoft judges, the top storytellers will be invited to present a virtual demo presentation to the judges during early August. You’ll be notified soon after if you have been selected as a finalist to share your story live at PPCC’s Got Power!  The live show will feature the solution demos and storytelling talents of the top contestants, winner announcements, and the opportunity to network with your community.  It's not just a showcase for technical talent and storytelling showmanship, show it's a golden opportunity to make connections and celebrate our Community together! Let's make this a memorable event! See you there!   Mark your calendars! Date and Time: Thursday, Sept 19th Location: PPCC24 at the MGM Grand, Las Vegas, NV 

Tuesday Tip | Accepting Solutions

It's time for another TUESDAY TIPS, your weekly connection with the most insightful tips and tricks that empower both newcomers and veterans in the Power Platform Community! Every Tuesday, we bring you a curated selection of the finest advice, distilled from the resources and tools in the Community. Whether you’re a seasoned member or just getting started, Tuesday Tips are the perfect compass guiding you across the dynamic landscape of the Power Platform Community.   To enhance our collaborative environment, it's important to acknowledge when your question has been answered satisfactorily. Here's a quick guide on how to accept a solution to your questions: Find the Helpful Reply: Navigate to the reply that has effectively answered your question.Accept as Solution: Look for the "Accept as Solution" button or link, usually located at the bottom of the reply.Confirm Your Selection: Clicking this button may prompt you for confirmation. Go ahead and confirm that this is indeed the solution.Acknowledgment: Once accepted, the reply will be highlighted, and the original post will be marked as "Solved". This helps other community members find the same solution quickly. By marking a reply as an accepted solution, you not only thank the person who helped you but also make it easier for others with similar questions to find answers. Let's continue to support each other by recognizing helpful contributions. 

Users online (3,636)