Skip to main content

​
What this page is for

API Integrations is for configuring named integrations that expose a predictable set of fields to the rest of your BillingServ setup. Each integration has a name, slug, enabled state, and field definitions. Fields can have a name, label, type, placeholder, default value, and options. Keep slugs stable once an integration is in use. Other systems may rely on them when sending or reading data.

​
Integration fields

  • Name: The label staff see in the integrations list.
  • Slug: The stable identifier used by API and automation references.
  • Enabled: Makes the integration available for use.
  • Field name: The internal key sent or received by the integration.
  • Field label: The human-readable label shown in forms.
  • Field type: The kind of input expected for the field.
  • Placeholder: Example text shown when the field is empty.
  • Default value: The value used when no custom value is supplied.
  • Options: The allowed choices for fields that use a list.
Use field names that are stable and machine-friendly. Use labels and placeholders to explain the expected value to staff or customers.