Ir al contenido

Update webhook

PATCH
/v1/webhooks/{id}
curl --request PATCH \
--url https://api.orderfast.com.ar/v1/webhooks/example \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "url": "https://partner.example.com/webhooks/orderfast", "events": [ "order.created" ], "status": "active" }'
id
required
string
Media typeapplication/json
object
url
string
Example
https://partner.example.com/webhooks/orderfast
events
Array<string>
Allowed values: order.created order.updated order.cancelled order.completed order.status_changed payment.created payment.updated payment.completed payment.rejected stock.updated product.created product.updated product.deleted catalog.updated sync.completed sync.failed turn.open turn.updated turn.closed settlement.created
Example
[
"order.created"
]
status
string
Allowed values: active disabled
Example
active
Example
{
"url": "https://partner.example.com/webhooks/orderfast",
"events": [
"order.created"
],
"status": "active"
}

Successful response

Media typeapplication/json
object
data
required
object
id
required
string
url
required
string
events
required
Array<string>
Allowed values: order.created order.updated order.cancelled order.completed order.status_changed payment.created payment.updated payment.completed payment.rejected stock.updated product.created product.updated product.deleted catalog.updated sync.completed sync.failed turn.open turn.updated turn.closed settlement.created
status
required
string
Allowed values: active disabled
created_at
required
string
Examples
Examplesuccess

Successful response

{
"data": {
"id": "wh_001",
"url": "https://partner.example.com/webhooks/orderfast",
"events": [
"order.created",
"payment.completed"
],
"status": "active",
"created_at": "2026-07-01T10:00:00.000Z"
}
}

Unauthorized — missing or invalid API key

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid_request unauthorized permission_denied resource_not_found conflict validation_error rate_limited internal_error
message
required
string
request_id
required
string
Examples
Exampleunauthorized

Invalid API key

{
"error": {
"code": "unauthorized",
"message": "Missing or invalid API key",
"request_id": "req_01J..."
}
}

Permission denied

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid_request unauthorized permission_denied resource_not_found conflict validation_error rate_limited internal_error
message
required
string
request_id
required
string
Examples
Examplepermission_denied

Missing permission

{
"error": {
"code": "permission_denied",
"message": "The API key does not have the required permission",
"request_id": "req_01J..."
}
}

Resource not found

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid_request unauthorized permission_denied resource_not_found conflict validation_error rate_limited internal_error
message
required
string
request_id
required
string
Examples
Exampleresource_not_found

Not found

{
"error": {
"code": "resource_not_found",
"message": "Webhook not found",
"request_id": "req_01J..."
}
}

Validation error

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid_request unauthorized permission_denied resource_not_found conflict validation_error rate_limited internal_error
message
required
string
request_id
required
string
Examples
Examplevalidation_error

Invalid body or query

{
"error": {
"code": "validation_error",
"message": "One or more fields failed validation",
"request_id": "req_01J..."
}
}

Internal server error

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid_request unauthorized permission_denied resource_not_found conflict validation_error rate_limited internal_error
message
required
string
request_id
required
string
Examples
Exampleinternal_error

Unexpected failure

{
"error": {
"code": "internal_error",
"message": "An unexpected error occurred",
"request_id": "req_01J..."
}
}