Skip to main content
Question

[NEED HELP] Connect Pigment with an External Service Through an API request

  • April 6, 2025
  • 2 replies
  • 112 views

I am currently testing an external API integration in Pigment to retrieve a response and display it within the platform.
 


Setup Details:

  • I configured an API connection in Pigment.

  • On the Action board, I added a card with a button to trigger the API call.

  • When I click the button, the API call is successfully triggered.

Issue:

  • Although the API call is being made, I am not receiving any JSON response within Pigment.

  • The response does not seem to be captured or displayed.

Questions:

  1. Is Pigment’s external API setup only meant for POST requests, or can it also handle GET requests and return responses?

  2. Can I retrieve the API response and manipulate or display it within Pigment?

  3. If yes, what is the proper way to map or use the response JSON in Pigment?


@Julien | ​@Igor P | ​@CDALMAY | ​@Thu Mai | ​@Jared Dolich 

2 replies

  • April 6, 2025

Hi, my understanding is that the external api can only trigger something but the response your api issues cannot be handled direcly within pigment.

Hence the documention stating "

  • POST HTTP requests only"...so no get method anyway

It s main purpose is to trigger a process in another application (typically a data pipeline / etl job or some equivalent that eventually send data to your pigment app)

So it s a one way api call, not a 2 way call.

I would be ace to be able to handle response to api calls and trigger stuff.. it would make for a great idea / enhancement feature.


  • Author
  • Apprentice Author
  • April 7, 2025

@FPA - Thanks for the details.
Does the body payload support only JSON, or can I send XML as well?

@Julien | ​@Igor P | ​@CDALMAY | ​@Thu Mai | ​@Jared Dolich