postback support (webhook)

[avelino]

asynchronous endpoint (which does not respond to the payload as soon as it receives the request), returns the identification (id), after X time makes a request to an "external api" (or another mock endpoint).

background processing can be a sleep (waiting time)

- endpoint:
    method: POST
    path: /with-postback
    response:
      status: 200
      headers:
        Content-Type: application/json
      body: {"id": 123}
    postback:
      sleep: 60 # in seconds
      webhook:
        field: webhook # field with url
        method: POST
        ... # other parameters for calling the api, ex auth
      body: {"id": 123, "another-field": "it's working"}

example:

curl
  --header "Content-Type: application/json" \
  --request POST \
  --data '{"webhook": "https://127.0.0.1:3000/my-endpoint-that-will-receive-the-postback"}' \
  /with-postback

[matheusfrancisco]

Wdyt in remove postback from the spec since it is under the postback path

- endpoint:
    method: POST
    path: /with-postback
    response:
      status: 200
      headers:
        Content-Type: application/json
      body: {"id": 123}
    webhook:
      path: https://api.test.com/api/webhook/:id/something #it will call an webhook with the id 123
      method: POST
      sleep: 60 # in seconds
        ... # other parameters for calling the api, ex auth
      body: {"id": 123, "another-field": "it's working"}

[avelino]

I like your proposal to remove the "postback" node, it simplifies the understanding and declaration of the specification

[avelino]

Should the webhook node be array or is it over engineering this feature for a mock system?

What's your opinion @matheusfrancisco?

[matheusfrancisco]

if it is an array would be easy to have multiple postbacks.

But I think can be done in two different pull request, adding the feature then improve it to be array (if necessary)