Global Security Forum

Security Global Forum

Our mission is to provide clients with an online user community of industry peers and IBM experts, to exchange tips and tricks, best practices, and product knowledge. We hope the information you find here helps you maximize the value of your IBM Security solutions.

 View Only
  • 1.  Connector API

    Posted Wed December 17, 2025 10:43 AM

    I'm creating an API connector using the SOAR function. I've done some testing and it works perfectly, but how can I send a variable within the field?

    The documentation only mentions using "playbook.inputs.xxxxxx", but the query can't possibly be an input!

    What alternatives do you think are possible?



    ------------------------------
    Juan Cruz Del Col
    ------------------------------


  • 2.  RE: Connector API

    Posted Thu December 18, 2025 05:43 AM
    Hi there. You can pass variables into a SOAR connector function, but they must come from places that the connector runtime understands (inputs, incident fields, artifacts, datatable rows, etc.), not from arbitrary "local" variables inside the query definition itself. Connector functions only resolve values that are available to the playbook at run time and are referenced through supported expressions.


    Common options:

    `playbook.inputs.<name>` for explicit playbook inputs.

    `incident.<field>` or `artifact.<field>` to use values from the current incident or artifact.

    Datatable/row fields (for example, inside a For Each Row loop) using the row's field references.

    If your "variable" is not really a playbook input but, say, an incident custom field, use `incident.my_custom_field` instead of creating a fake input.

    If the connector UI only shows playbook.inputs
    Some early or simple examples in the docs and community posts only show `playbook.inputs.xxxx`, which is confusing when the value clearly comes from elsewhere.  In practice, you can:

    Define a playbook input and map it from an incident or artifact field in the "Input Mappings" section, then reference it as `playbook.inputs.my_input` in the connector.

    Or, where supported in newer connector/REST function UIs, reference incident or artifact context directly (for example, `incident.id`, `incident.properties.<field>`, `artifact.value`) in URL path, query string, or body templates.

    The first approach is the most portable and works even if the UI only documents `playbook.inputs.*`.

    Cheers! Hope this helps a little. Maybe someone else has suggestion that can help too. Happy Holidays