I always get a "Success" HTTP response even though I'm issuing a custom response from my workflow

Help
,
1

This topic was automatically generated from Slack. You can find the original thread here.

Vincent Lo : I am trying to get a custom response from a Lambda call back to a webhook/HTTP trigger but regardless of what I do, I always get the default “Success!
To customize this response, check out our docs here” message. I have tried many combinations of the code below

const AWS = require('aws-sdk')
const { accessKeyId, secretAccessKey } = auths.aws
const { region, FunctionName, eventData } = params

const lambda = new AWS.Lambda({
  accessKeyId,
  secretAccessKey,
  region
})

const lambdaParams = {
  Payload: eventData,
  FunctionName,
  InvocationType: "RequestResponse",
  LogType: "Tail",
}

this.res = await lambda.invoke(lambdaParams).promise()

this.res = await $respond({
  status: 200,
  headers: { "my-custom-header": "value" },
  body: { message: "My custom response" } // This can be any string, object, or Buffer
})
2

Dylan Sather (Pipedream) : just to confirm, are you using a Pipedream workflow, or an event source?

Can you remove the this.res = await portion of the $respond code?

$respond() should run synchronously the way you’re using it (so no need for the await ), and you’ll see the HTTP response that’s issued for a specific HTTP response in the observability of the trigger step (in steps.trigger.response), when you select a specific event, so you don’t need to add this.res to save the response:

Screen Shot 2020-10-09 at 4.46.37 PM.png
Screen Shot 2020-10-09 at 4.46.37 PM.png958×476 33.2 KB

3

Dylan Sather (Pipedream) : so if you just run:

$respond({
  status: 200,
  headers: { "my-custom-header": "value" },
  body: { message: "My custom response" },
});

it should work

4

Vincent Lo : yes, I am using a Pipedream workflow, through a webhook trigger to a Jotform. I then invoke a Lamda and am trying to respond with an event json eventually
thank you for your response, i shall eagerly try it now!

5

Dylan Sather (Pipedream) : great, if that doesn’t work, feel free to add dylan@pipedream.com as a workflow collaborator and I can take a look at your setup

6

Vincent Lo : hmm, still no joy. below is screenshot of entire step.

image.png
image.png1050×216 19.8 KB

image.png
image.png1416×1024 123 KB

7

Dylan Sather (Pipedream) : ah so, are you using the Typeform event source (at Sources - Pipedream), and triggering the workflow from that?

8

Vincent Lo : I can see the response trying to get out…!

image.png
image.png748×662 48.5 KB

9

Vincent Lo : yes, i am using the built-in webhook creator that generates and connects the trigger to jotform

image.png
image.png1232×292 24 KB

10

Dylan Sather (Pipedream) : got it, so currently because of how event sources trigger workflows, you can’t issue a custom response all the way from the workflow back to the client that called the event source. Do you need to issue a custom response based on the response from Lambda, or do you just need to issue a more custom, static response?

If you just want to return a custom, static response from the event source itself, visit Sources - Pipedream and select your Typeform source, click on the Configuration tab and you’ll see the code for that source. You’ll need to do two things:

First, change the line that reads http: "$.interface.http", to

http: {
  type: "$.interface.http",
  customResponse: true,
},

Then, issue the response you want using a similar API as the $respond() code you used earlier:

this.http.respond({
  status: 200,
  body: { message: "My custom response" },
  headers: { "my-custom-header": "value" },
});
11

Vincent Lo : i just thought i was going nuts. ok, i shall have a play.
Thank you! :thumbsup:

12

Dylan Sather (Pipedream) : this limitation is definitely not obvious, I’ll actually document this clearly in that section of the HTTP response docs

13

Vincent Lo : nearly there i think. do I need to import something?

image.png
image.png1118×630 63.4 KB

14

Dylan Sather (Pipedream) : ah so that code I referenced above will actually need to go into your Typeform event source, at Sources - Pipedream

15

Vincent Lo : sorry, i’m a bit lost. the event source is below, after adding customresponse: true

const jotform = require('https://github.com/PipedreamHQ/pipedream/components/jotform/jotform.app.js')

module.exports = {
  name: "new-submission",
  version: "0.0.2",
  props: {
    jotform,
    formId: { propDefinition: [jotform, "formId"] },
    http: {
      type: "$.interface.http",
      customResponse: true,
    },
  },
  hooks: {
    async activate() {
      return (await this.jotform.createHook({
        endpoint: this.http.endpoint,
        formId: this.formId,
      }))
    },
    async deactivate() {
      return (await this.jotform.deleteHook({
        endpoint: this.http.endpoint,
        formId: this.formId,
      }))
    },
  },
  async run(event) {
    event.body.formData = JSON.parse(event.body.rawRequest)

    this.$emit(event.body, {
      summary: event.body.rawRequest || JSON.stringify(event.body),
      id: event.body.submissionID,
    })
  },
}
16

Vincent Lo : its not clear to me where I should add

this.http.respond({
  status: 200,
  body: { message: "My custom response" },
  headers: { "my-custom-header": "value" },
});
17

Dylan Sather (Pipedream) : ah sorry, that should go within the run method near the bottom. Since the HTTP response happens asynchronously (technically it happens after the code runs), you can actually put it anywhere. I like to put it near the top of the run method to clarify that we’re issuing a response, so that section should read:

async run(event) {
  this.http.respond({
    status: 200,
    body: { message: "My custom response" },
    headers: { "my-custom-header": "value" },
  });

  event.body.formData = JSON.parse(event.body.rawRequest)

  this.$emit(event.body, {
    summary: event.body.rawRequest || JSON.stringify(event.body),
    id: event.body.submissionID,
  })
},
18

Dylan Sather (Pipedream) : We refer to Pipedream event sources generically as “components”, and you can read more about the API for those here: pipedream/COMPONENT-API.md at master · PipedreamHQ/pipedream · GitHub

Over time we’re planning to unify more about workflows and event sources / components, so there should be fewer inconsistencies with HTTP responses and other features in the future!

19

Vincent Lo : Omg, it worked! I can get custom headers now!

20

Vincent Lo : so the question is, how do i call/use/set this in the main workflow? still use $respond or something else now?

$respond({
  status: 200,
  headers: { "my-custom-header": "value" },
  body: { message: "My custom response" },
});