Registra un endpoint de webhook

POST

/api/v1/webhooks

curl --request POST \
  --url https://api.novafe.example/api/v1/webhooks \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "url": "example", "events": [ "example" ], "description": "example" }'

La respuesta incluye el secret, que solo se muestra esta vez.

Autenticación: requiere una API key (header X-API-Key) con rol admin_tenant.

Authorizations

• ApiKey

Request Body^required

object

url

required

null | string

events

required

Array<string> | null

description

required

null | string

Example^generated

{
  "url": "example",
  "events": [
    "example"
  ],
  "description": "example"
}

object

url

required

null | string

events

required

Array<string> | null

description

required

null | string

Example^generated

{
  "url": "example",
  "events": [
    "example"
  ],
  "description": "example"
}

object

url

required

null | string

events

required

Array<string> | null

description

required

null | string

Example^generated

{
  "url": "example",
  "events": [
    "example"
  ],
  "description": "example"
}

Responses

201

Created

Respuesta de la creación de un endpoint: la vista más el secret en claro, que solo se devuelve aquí (y en rotate-secret) y no se puede recuperar.

object

endpoint

required

Vista de un endpoint de webhook. Nunca incluye el secret.

object

id

required

string format: uuid

tenantId

required

string format: uuid

url

required

string

description

required

null | string

events

required

Array<string>

enabled

required

boolean

consecutiveFailures

required

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

disabledReason

required

null | string

disabledAt

required

null | string format: date-time

createdAt

required

string format: date-time

updatedAt

required

null | string format: date-time

secret

required

string

Respuesta de la creación de un endpoint: la vista más el secret en claro, que solo se devuelve aquí (y en rotate-secret) y no se puede recuperar.

object

endpoint

required

Vista de un endpoint de webhook. Nunca incluye el secret.

object

id

required

string format: uuid

tenantId

required

string format: uuid

url

required

string

description

required

null | string

events

required

Array<string>

enabled

required

boolean

consecutiveFailures

required

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

disabledReason

required

null | string

disabledAt

required

null | string format: date-time

createdAt

required

string format: date-time

updatedAt

required

null | string format: date-time

secret

required

string

Example^generated

{
  "endpoint": {
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "tenantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "url": "example",
    "description": "example",
    "events": [
      "example"
    ],
    "enabled": true,
    "consecutiveFailures": 1,
    "disabledReason": "example",
    "disabledAt": "2026-04-15T12:00:00Z",
    "createdAt": "2026-04-15T12:00:00Z",
    "updatedAt": "2026-04-15T12:00:00Z"
  },
  "secret": "example"
}

Respuesta de la creación de un endpoint: la vista más el secret en claro, que solo se devuelve aquí (y en rotate-secret) y no se puede recuperar.

object

endpoint

required

Vista de un endpoint de webhook. Nunca incluye el secret.

object

id

required

string format: uuid

tenantId

required

string format: uuid

url

required

string

description

required

null | string

events

required

Array<string>

enabled

required

boolean

consecutiveFailures

required

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

disabledReason

required

null | string

disabledAt

required

null | string format: date-time

createdAt

required

string format: date-time

updatedAt

required

null | string format: date-time

secret

required

string

Example^generated

{
  "endpoint": {
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "tenantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "url": "example",
    "description": "example",
    "events": [
      "example"
    ],
    "enabled": true,
    "consecutiveFailures": 1,
    "disabledReason": "example",
    "disabledAt": "2026-04-15T12:00:00Z",
    "createdAt": "2026-04-15T12:00:00Z",
    "updatedAt": "2026-04-15T12:00:00Z"
  },
  "secret": "example"
}

400

Bad Request

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

errors

object

key

additional properties

Array<string>

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

errors

object

key

additional properties

Array<string>

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

errors

object

key

additional properties

Array<string>

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}