Processing of output parameters

How to process the API response

The best approach is to return the API response as it is. In many cases, the response varies based on the user who is using the app, as responses can contain different custom fields, etc. If the response returned is unchanged, and if still all the parameters aren't described in the output parameters, Make will automatically learn additional parameters from actual incoming data and propose them for mapping.

Good practice (Search)

"response": {
    "output": "{{item}}",
    "iterate": "{{body}}"
}

Bad practice (Search)

"response": {
    "output": {
        "id": "{{item.id}}",
        "name": "{{item.name}}"
    },
    "iterate": "{{body}}"
}

Good practice (Action)

"response": {
    "output": "{{body}}"
}

Bad practice (Action)

"response": {
    "output": {
        "id": "{{body.id}}",
        "name": "{{body.name}}"
    }
}

Response output

A module's response output should be defined for the case when a request is fulfilled successfully. The output definition should under no conditions contain error messages (this belongs in the Base section's error handling) nor the additional metadata which may arrive bundled with the actual response information.

Wrong

No matter the module type, the output shouldn't be defined like this:

Showing dates correctly

Requires IML functions enabled.

There are multiple ways how a date can be returned from the service, either as a timestamp or in any format the service finds fit. It is important to parse this date to our ISO 8601 format so it is shown in an output of the module as a date using the users' localization and timezone.

Make is using ISO 8601 format: YYYY-MM-DDTHH:mm:ss.sssZ

Any other format, even just without milliseconds won't be shown correctly in the output and needs to be parsed using an IML function.

https://github.com/integromat/make-apps-sdk-docs/blob/master/best-practices/broken-reference/README.md

https://github.com/integromat/make-apps-sdk-docs/blob/master/best-practices/broken-reference/README.md

Interface

The interface describes the structure of output bundles and specifies the parameters which are seen in the next modules. It should contain the full response from the API, including nested parameters.

You can generate an interface using our Interface Generator, learn how in Interface Generator section.

Interface