Sites  /  List value sources

List value sources

POST/v1/sites/{id}/value-sources

Find out which values a site's trigger can send with a conversion, like the total price of each Acuity Scheduling booking. Send the flow's trigger and the action you're building, and Converly returns each value it could use, with whether you can use it right now. Store the triggerId and sourceId of the one you pick in the action's config.conversion.valueSource.

Path parameters
id
string · required
The site id.
Body parameters
trigger
object · required
The flow's trigger_config. Include integrationId and triggerId.
action
object · required
The action you're building, as it appears in actions_config: integrationId, config (including the conversion's currency), and id if it already exists.
Response fields
version
integer
Always 1.
sources
array
Every value this trigger can supply for this action. Empty when it supplies none.
sources[].triggerId
string
Store this in valueSource.
sources[].sourceId
string
Store this in valueSource.
sources[].intent
string
The value's name as the dashboard shows it, e.g. Each booking’s total price.
sources[].label
string
A short name, e.g. Booking price.
sources[].description
string
What the value contains.
sources[].currencyMode
string
How the currency is set. declared means Converly uses the currency on the action.
sources[].structural
object
{ eligible, reason }. Whether this value can work with this trigger and destination at all.
sources[].availability
object
{ available, reason }. Whether this site can use it right now.
sources[].publication
object
{ allowed, reason }. Whether a flow using it can be published.
selected
object | null
The same three checks for the valueSource already on your action, or null when it has none.

This is a POST because it takes your draft action in the body, but it changes nothing and sends no conversion. It needs the flows:read permission.

Only pick a value whose structural.eligible, availability.available and publication.allowed are all true. Each reason says why when one is false.

The answer reflects the site as it is now. Check again after you change the flow's trigger or destination. A 404 means the site isn't in this key's scope. A 503 means the check couldn't run, so retry it and keep any value source the flow already has.
POST/v1/sites/{id}/value-sources
curl https://app.converly.io/api/v1/sites/site_29Et…/value-sources \
  -H "Authorization: Bearer sk_live_…" \
  -d '{
    "trigger": {
      "integrationId": "acuity-scheduling",
      "triggerId": "acuity-appointment-scheduled"
    },
    "action": {
      "integrationId": "meta",
      "config": {
        "conversion": { "event_name": "Schedule", "currency": "USD" }
      }
    }
  }'
200 OK
{
  "version": 1,
  "sources": [
    {
      "id": "acuity.booking_price",
      "sourceId": "acuity.booking_price",
      "triggerId": "acuity-appointment-scheduled",
      "intent": "Each booking’s total price",
      "label": "Booking price",
      "description": "The price Acuity reports for this appointment, after discounts and redeemed credits, including add-ons.",
      "icon": "acuity",
      "acquisitionStage": "server",
      "channels": ["server"],
      "currencyMode": "declared",
      "resolverVersion": 1,
      "structural": { "eligible": true, "reason": null },
      "availability": { "available": true, "reason": null },
      "publication": { "allowed": true, "reason": null }
    }
  ],
  "selected": null
}