Create webhook endpoint

POST

/v2/webhook-endpoints

curl --request POST \
  --url https://api.orderfast.com.ar/v2/webhook-endpoints \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: example' \
  --header 'idempotency-key: example' \
  --data '{ "url": "https://partner.example.com/webhooks/orderfast", "events": [ "order.created", "payment.completed" ] }'

• Production
• Testing
• Local

Returns the endpoint plus a one-time secret. Requires Idempotency-Key.

Authorizations

• api-key

Parameters

Header Parameters

idempotency-key

required

string

Idempotency-Key

required

string

Unique key to safely retry webhook creation

Request Body^required

Media typeapplication/json

object

url

required

string

Example

https://partner.example.com/webhooks/orderfast

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

Example

[
  "order.created",
  "payment.completed"
]

Example

{
  "url": "https://partner.example.com/webhooks/orderfast",
  "events": [
    "order.created",
    "payment.completed"
  ]
}

Responses

201

Resource created

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

secret

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",
    "secret": "whsec_abc123..."
  }
}

401

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..."
  }
}

403

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..."
  }
}

409

Conflict

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

Exampleconflict

Conflict / idempotency mismatch

{
  "error": {
    "code": "conflict",
    "message": "Idempotency-Key was already used with a different request body",
    "request_id": "req_01J..."
  }
}

422

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..."
  }
}

500

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..."
  }
}