AppPilot

AppPilot

Automatisch toegevoegd vanuit OpenAPI sync.

Flows ophalen

GET /v1/apppilot/flows
apppilot.read
Authorization: HTTP
name: httpBearer
type: http
scheme: bearer
Query
Naam Type Beschrijving
page integer
per_page integer
trigger_type string
active string Filter active flows (`0`/`1`/`true`/`false`)
Request body

Geen

Response
data array Required
id string
name string
description string
category string
trigger_type string
trigger_key string
active boolean
step_count integer
created_at string
updated_at string
meta object Required
page integer Required
per_page integer Required
total integer Required
pages integer Required

Examples

GET /v1/apppilot/flows
curl -X GET "https://api.appficient.nl/v1/apppilot/flows" \
  -H "Authorization: Bearer apf_xxxxxxxx" \
  -H "Accept: application/json"

Curl, Node en response staan rechts naast dit endpoint.

Flow ophalen

GET /v1/apppilot/flows/{id}
apppilot.read
Authorization: HTTP
name: httpBearer
type: http
scheme: bearer
Path
Naam Type Beschrijving
id Required string Resource id (UUID, lowercase)
Request body

Geen

Response
data object Required
id string
name string
description string
category string
trigger_type string
trigger_key string
active boolean
step_count integer
created_at string
updated_at string
meta object Required

Examples

GET /v1/apppilot/flows/{id}
curl -X GET "https://api.appficient.nl/v1/apppilot/flows/{id}" \
  -H "Authorization: Bearer apf_xxxxxxxx" \
  -H "Accept: application/json"

Curl, Node en response staan rechts naast dit endpoint.

Flow bijwerken

PATCH /v1/apppilot/flows/{id}
apppilot.write
Authorization: HTTP
name: httpBearer
type: http
scheme: bearer
Path
Naam Type Beschrijving
id Required string Resource id (UUID, lowercase)
Headers
Naam Type Beschrijving
Idempotency-Key string Optional on POST only; cached 24h; replay returns X-Idempotent-Replay
Request body
active boolean Required
Response
data object Required
id string
name string
description string
category string
trigger_type string
trigger_key string
active boolean
step_count integer
created_at string
updated_at string
meta object Required

Examples

PATCH /v1/apppilot/flows/{id}
curl -X PATCH "https://api.appficient.nl/v1/apppilot/flows/{id}" \
  -H "Authorization: Bearer apf_xxxxxxxx" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "active": false
}'

Curl, Node en response staan rechts naast dit endpoint.

Runs ophalen

GET /v1/apppilot/runs
apppilot.read
Authorization: HTTP
name: httpBearer
type: http
scheme: bearer
Query
Naam Type Beschrijving
page integer
per_page integer
status string
flow_id string Filter by flow UUID
Request body

Geen

Response
data array Required
id string
flow_id string
flow_name string
status string
trigger_type string
trigger_key string
entity_type string
attempts integer
max_attempts integer
actions_done integer
error string
created_at string
updated_at string
next_attempt_at string
meta object Required
page integer Required
per_page integer Required
total integer Required
pages integer Required

Examples

GET /v1/apppilot/runs
curl -X GET "https://api.appficient.nl/v1/apppilot/runs" \
  -H "Authorization: Bearer apf_xxxxxxxx" \
  -H "Accept: application/json"

Curl, Node en response staan rechts naast dit endpoint.

Run ophalen

GET /v1/apppilot/runs/{id}
apppilot.read
Authorization: HTTP
name: httpBearer
type: http
scheme: bearer
Path
Naam Type Beschrijving
id Required string Resource id (UUID, lowercase)
Request body

Geen

Response
data object Required
id string
flow_id string
flow_name string
status string
trigger_type string
trigger_key string
entity_type string
attempts integer
max_attempts integer
actions_done integer
error string
created_at string
updated_at string
next_attempt_at string
meta object Required

Examples

GET /v1/apppilot/runs/{id}
curl -X GET "https://api.appficient.nl/v1/apppilot/runs/{id}" \
  -H "Authorization: Bearer apf_xxxxxxxx" \
  -H "Accept: application/json"

Curl, Node en response staan rechts naast dit endpoint.

Run annuleren

POST /v1/apppilot/runs/{id}/cancel
apppilot.write
Authorization: HTTP
name: httpBearer
type: http
scheme: bearer
Path
Naam Type Beschrijving
id Required string Resource id (UUID, lowercase)
Headers
Naam Type Beschrijving
Idempotency-Key string Optional on POST only; cached 24h; replay returns X-Idempotent-Replay
Request body

Geen

Response
data object Required
id string
status string
meta object Required

Examples

POST /v1/apppilot/runs/{id}/cancel
curl -X POST "https://api.appficient.nl/v1/apppilot/runs/{id}/cancel" \
  -H "Authorization: Bearer apf_xxxxxxxx" \
  -H "Accept: application/json"

Curl, Node en response staan rechts naast dit endpoint.

Event triggeren

POST /v1/apppilot/trigger
apppilot.write
Authorization: HTTP
name: httpBearer
type: http
scheme: bearer
Headers
Naam Type Beschrijving
Idempotency-Key string Optional on POST only; cached 24h; replay returns X-Idempotent-Replay
Request body
event string Required

Required free string matched against AppPilot trigger contracts (or custom manual keys). Catalog below is the built-in contract set; additional custom event keys are still accepted.

Enum
ticket.inbound_message ticket.created ticket.status_changed ticket.closed ticket.message ticket.stale quote.phase_changed quote.viewed quote.accepted quote.created quote.converted_to_project quote.silent deal.won deal.lost deal.phase_changed deal.quote_accepted deal.created deal.stalled deal.phase_idle deal.close_due deal.no_followup sales.document_sent invoice.created invoice.credited invoice.paid invoice.late project.created project.completed project.status_changed project.phase_completed work
data object
entity_type string
legacy_entity_id integer

Input only (context); not echoed as a public resource id Removed in v2.

Response
data object Required
event string
matched integer
runs array
flow_id string
run_id string
status string

Opaque executor status (failed, pending_approval, waiting, retrying, partial, cancelled, success variants, …)

meta object Required

Examples

POST /v1/apppilot/trigger
curl -X POST "https://api.appficient.nl/v1/apppilot/trigger" \
  -H "Authorization: Bearer apf_xxxxxxxx" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "event": "ticket.inbound_message",
    "data": [],
    "entity_type": "string",
    "legacy_entity_id": 0
}'

Curl, Node en response staan rechts naast dit endpoint.