NexCommand AINexCom Knowledge Base
Field reference

Webhook

How to use Webhook in Integrations & API Docs: access, working steps, fields, related records and troubleshooting.

System AdminUpdated 12 October 2026Configuration-aware guidance
Open Webhook ↗Module guide

Purpose and access

Use the API documentation at api.nexcommand.ai, obtain the required authorized credentials and use the deployment-specific service URLs. SaaS tenants and on-premises installations must retain their own endpoints and access boundaries.

This page is a record page in System Admin → Integrations & API Docs. Use the link above to open the configured destination; permissions are checked by the destination service.

ERP links open in a new tab. Sign in with your own account; record visibility, actions and approval authority follow your assigned permissions. Screens can differ by company and configuration.

Before you start

Prepare the required information: DocType, Request URL, Request Method.

Confirm the company, party, dates, units and source references that apply. Select existing links carefully and check for an existing record before creating a duplicate.

Working steps

  1. Open Webhook from System Admin → Integrations & API Docs, or use ERP Search.
  2. Filter the list and open the relevant record. To add a record, use Add/New when your role provides that action.
  3. Complete the editable fields described below. Required fields and validation conditions must be satisfied; read-only values are set by the system or their source records.
  4. Add the required child rows. Review each row’s identifiers, linked records and values, using the child-table field reference below.
  5. Save the record and address validation messages. Reload and verify the saved values and relationships.
  6. Use any additional workflow actions only when the record and your role provide them. Saving this record does not automatically complete a related transaction or external action.

Field reference

These fields come from the installed ERP definition. Hidden fields and password inputs are omitted. Additional conditions, custom scripts and workflow rules can make a field required or read-only in a particular context.

FieldType / behaviorHow to use it
DocTypewebhook_doctypeLink
Required		Choose an existing linked record. Check its company and ownership; typing a label alone does not create a new relationship.

Linked record: DocType

Doc Eventwebhook_doceventSelect
Optional		Choose one of the configured list values. Status fields may be controlled by the record workflow.
Available choices
  • after_insert
  • on_update
  • on_submit
  • on_cancel
  • on_trash
  • on_update_after_submit
  • on_change
  • workflow_transition
EnabledenabledCheck
Optional		Enable or disable the named option only when it matches the intended record behavior.
ConditionconditionSmall Text
Optional		The webhook will be triggered if this expression is true
Request URLrequest_urlSmall Text
Required		Provide concise contextual information relevant to the record. Avoid unrelated personal or confidential data.
Is Dynamic URL?is_dynamic_urlCheck
Optional		On checking this option, URL will be treated like a jinja template string
Request TimeouttimeoutInt
Optional		The number of seconds until the request expires
Background Jobs Queuebackground_jobs_queueAutocomplete
Optional		Complete the value according to the field label and the record’s validation rules.
Request Methodrequest_methodSelect
Required		Choose one of the configured list values. Status fields may be controlled by the record workflow.
Available choices
  • POST
  • PUT
  • DELETE
Request Structurerequest_structureSelect
Optional		Choose one of the configured list values. Status fields may be controlled by the record workflow.
Available choices
  • Form URL-Encoded
  • JSON
Enable Securityenable_securityCheck
Optional		Enable or disable the named option only when it matches the intended record behavior.
Headerswebhook_headersTable
Optional		Add the relevant child rows and review required columns, quantities and references before saving.

Linked record: Webhook Header

Datawebhook_dataTable
Optional		Add the relevant child rows and review required columns, quantities and references before saving.

Linked record: Webhook Data

JSON Request Bodywebhook_jsonCode
Optional		To add dynamic values from the document, use jinja tags like { "id": "{{ doc.name }}" }

Child tables

Headers — child-row fields
FieldType / behaviorHow to use it
KeykeySmall Text
Optional		Provide concise contextual information relevant to the record. Avoid unrelated personal or confidential data.
ValuevalueSmall Text
Optional		Provide concise contextual information relevant to the record. Avoid unrelated personal or confidential data.
Data — child-row fields
FieldType / behaviorHow to use it
FieldnamefieldnameSelect
Required		Choose one of the configured list values. Status fields may be controlled by the record workflow.
KeykeyData
Required		Enter the identifier or short text requested by the label. Preserve external reference numbers accurately.

Troubleshooting

  • Not permitted: verify the account, role and source-document permission. Do not share an administrator login.
  • Missing record or address: inspect the relevant Link or Dynamic Link fields; a matching title alone does not establish a relationship.
  • Cannot save or change status: review required fields, read-only values, document status and the configured approval transition.
  • Unexpected report or portal result: review company/date filters, source-document submission and the approved party or Employee link.
Was this useful?