Update output config

PUT

/api/v1/integrations/outputs/{id}

Code sample: cURL

curl -X PUT 'https://dashboard.justcrawl.io/api/v1/integrations/outputs/oc_01ABC' \
  -H 'Authorization: Bearer $JUSTCRAWL_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"name":"Renamed webhook","destination":"https://new.example.com/justcrawl-events"}'

• Production

Partially updates an existing output destination. Supply any subset of name / credentials / destination; omitted fields stay as-is. When credentials is supplied, the new value is AES-256-GCM re-encrypted at rest before write — the old value is overwritten in place. When destination is supplied for a webhook output, the same SSRF defense as POST /outputs rejects localhost / private IPs / .internal / .local / AWS-metadata-IP destinations.

The system-managed internal config cannot be edited via this endpoint — pass its id and the storage layer will silently reject (system-managed flag is enforced at the DB layer, not this route). Requires the org:manage permission.

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string

Output config ID.

Request Body ^required

Media type application/json

object

name

string

credentials

New credentials object. Same shape as POST /outputs (S3 requires accessKeyId+secretAccessKey+region; webhook requires hmacSecret). Re-encrypted on save.

object

destination

New destination. Webhook URLs are SSRF-checked on update.

string

Example ^generated

{
  "name": "example",
  "credentials": {},
  "destination": "example"
}

Responses

200

Updated output configuration.

Media type application/json

object

id

string format: uuid

name

string

outputType

string

Allowed values: s3 webhook

destination

string

isEnabled

boolean

lastDeliveredAt

string format: date-time

nullable

lastError

string

nullable

createdAt

string format: date-time

Example

{
  "outputType": "s3"
}

400

Validation failed — request body or query is missing/invalid

Media type application/json

object

error

string

Example

{
  "error": "Missing or invalid \"url\" field"
}

401

Missing or invalid authentication token

Media type application/json

object

error

string

Example

{
  "error": "Missing or invalid authentication token"
}

403

Insufficient permissions for this operation

Media type application/json

object

error

string

Example

{
  "error": "No organization. Complete onboarding first."
}

404

Resource not found

Media type application/json

object

error

string

Example

{
  "error": "Workflow not found"
}

500

Unexpected server error. Logs and PostHog $exception capture

Media type application/json

object

error

string

Example

{
  "error": "Something went wrong"
}