Skip to main content
PUT
/
deals
/
{dealId}
/
agent
Initialize the deal agent (async)
curl --request PUT \
  --url https://app.hockeystack.com/api/revenue-agents/v1/deals/{dealId}/agent \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "deal_id": "<string>",
  "agent_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "last_synced_at": "2023-11-07T05:31:56Z",
  "job_id": "<string>",
  "progress_stream_url": "<string>",
  "failed_at": "2023-11-07T05:31:56Z",
  "error": "<string>",
  "retry_with": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
dealId
string
required

CRM deal ID (HubSpot/Salesforce object ID).

Required string length: 1 - 64

Body

application/json

Currently no body fields are honored. Reserved for v2.

Response

Provisioning started.

Polymorphic agent-state envelope. Required fields: deal_id + status. Other fields' presence depends on status:

  • active — agent_id, created_at, last_synced_at populated
  • initializing — job_id, progress_stream_url populated; agent_id may be stale or null
  • provisioning_failed — job_id, failed_at, error, retry_with populated; agent_id null
​
deal_id
string
required
​
status
enum<string>
required

active — agent is provisioned and ready. initializing — async provisioning worker is in flight; poll until it flips. provisioning_failed — most recent provisioning run failed; PUT again to retry.

Available options:
active,
initializing,
provisioning_failed
​
agent_id
string | null
​
created_at
string<date-time> | null
​
last_synced_at
string<date-time> | null
​
job_id
string | null
​
progress_stream_url
string
​
failed_at
string<date-time> | null
​
error
string | null
​
retry_with
string