remoteEaze

Third-party systems and delivery hooks

How to configure authorized external delivery.

Third Party Delivery sends selected remoteEaze record events to configured external systems.

The configuration has four connected parts:

  1. A Third-Party System defines the destination and authentication.
  2. An External ID connects a remoteEaze record to that System's identifier.
  3. A Hook Config chooses an event and maps its data to the outbound request.
  4. A Delivery Log records each attempt and its response.

Configure a System

Open Processing & Monitoring → Third Party Delivery → Systems. With Create Third Party System, define the code, name, transport format, base URL, authentication method and secret values, default headers, timeout, retry limit/backoff, and Active state. Save or submit through maker-checker.

Authentication values are encrypted at rest and are not a substitute for careful permission assignment. Updating an Authorized System uses an Amendment when required.

Use the Base URL for the shared host and the Hook Endpoint Path for the event-specific resource. Default Headers apply to Hooks using the System. Timeout, retry limit, and backoff control delivery-worker behavior when the remote endpoint is unavailable or returns a retryable result.

Configure a Hook

Open Hook Configs and select Create Hook Config. Choose:

  • the Authorized System, entity type, and event such as Create, Update, Submit, Authorize, Reject, or Deny;
  • endpoint path, POST/PUT/PATCH method, and transport format;
  • source-to-target field mappings and optional response mappings;
  • retry overrides and Active state.

Save or submit the Hook through maker-checker. The source field registry shows which fields are available and supports mapping validation.

Map the request

Choose a source field from the registry, then enter its target path. A target path places the value in the JSON object or XML structure sent to the external System. Nested paths create nested output. Keep each destination path unique so two source values do not overwrite one another.

Required external fields must either have a mapped source or an explicit value supported by the editor. Preview the generated payload before authorizing the Hook.

An External ID mapping can supply the external identifier expected by the destination. The Hook still needs a valid mapping from that value to the correct target path.

Map the response

Response mappings read supported values returned by the external System. Use them to capture a returned identifier or another configured result field. When a returned identifier creates or updates an External ID, confirm the System, Entity Type, External Key, Value Type, and response path.

Response mapping records supported delivery results and identifiers. It does not bypass the permissions or maker-checker rules of the business entity.

With Update Delivery Hook Config, an Authorized Hook can run a Test Delivery for a selected entity record. Tests perform a real external request and create a Delivery Log, so use a safe test record and endpoint.

Review External ID mappings before testing a Hook that depends on external identifiers, and use Delivery Logs to inspect the attempt.

On this page