Create Endpoint

POST /v1/webhooks/endpoints

Authentication

Requires authentication via: OAuth2PasswordBearer.

Parameters

Name	In	Type	Required	Description	Constraints
X-API-Key	header	string | null	No		nullable

Request Body

Required: Yes

application/json

Resolved schema:

{
  "properties": {
    "url": {
      "type": "string",
      "title": "Url"
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Description"
    },
    "event_patterns": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Event Patterns"
    },
    "timeout_seconds": {
      "type": "integer",
      "maximum": 60,
      "minimum": 3,
      "title": "Timeout Seconds",
      "default": 10
    },
    "max_retries": {
      "type": "integer",
      "maximum": 7,
      "minimum": 1,
      "title": "Max Retries",
      "default": 7
    }
  },
  "type": "object",
  "required": [
    "url"
  ],
  "title": "WebhookEndpointCreateRequest"
}

Field details:

Field	Type	Required	Description	Constraints
url	string	Yes
description	string | null	No		nullable
event_patterns	array<string> | null	No		nullable
event_patterns[]	string	No
timeout_seconds	integer	No		default=10, min=3, max=60
max_retries	integer	No		default=7, min=1, max=7

Responses

200

Successful Response

application/json

Resolved schema:

{
  "properties": {
    "endpoint": {
      "properties": {
        "id": {
          "type": "string",
          "title": "Id"
        },
        "user_id": {
          "type": "integer",
          "title": "User Id"
        },
        "url": {
          "type": "string",
          "title": "Url"
        },
        "description": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Description"
        },
        "status": {
          "type": "string",
          "title": "Status"
        },
        "enabled": {
          "type": "boolean",
          "title": "Enabled"
        },
        "subscribed_event_patterns": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "title": "Subscribed Event Patterns"
        },
        "signing_version": {
          "type": "string",
          "title": "Signing Version"
        },
        "secret_hint": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Secret Hint"
        },
        "timeout_seconds": {
          "type": "integer",
          "title": "Timeout Seconds"
        },
        "max_retries": {
          "type": "integer",
          "title": "Max Retries"
        },
        "consecutive_failures": {
          "type": "integer",
          "title": "Consecutive Failures"
        },
        "last_verified_at": {
          "anyOf": [
            {
              "type": "string",
              "format": "date-time"
            },
            {
              "type": "null"
            }
          ],
          "title": "Last Verified At"
        },
        "last_delivery_at": {
          "anyOf": [
            {
              "type": "string",
              "format": "date-time"
            },
            {
              "type": "null"
            }
          ],
          "title": "Last Delivery At"
        },
        "last_error": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Last Error"
        },
        "created_at": {
          "type": "string",
          "format": "date-time",
          "title": "Created At"
        },
        "updated_at": {
          "type": "string",
          "format": "date-time",
          "title": "Updated At"
        }
      },
      "type": "object",
      "required": [
        "id",
        "user_id",
        "url",
        "status",
        "enabled",
        "signing_version",
        "timeout_seconds",
        "max_retries",
        "consecutive_failures",
        "created_at",
        "updated_at"
      ],
      "title": "WebhookEndpointResponse"
    },
    "secret": {
      "type": "string",
      "title": "Secret"
    }
  },
  "type": "object",
  "required": [
    "endpoint",
    "secret"
  ],
  "title": "WebhookEndpointCreateResponse"
}

Field details:

Field	Type	Required	Description	Constraints
endpoint	object	Yes
endpoint.id	string	Yes
endpoint.user_id	integer	Yes
endpoint.url	string	Yes
endpoint.description	string | null	No		nullable
endpoint.status	string	Yes
endpoint.enabled	boolean	Yes
endpoint.subscribed_event_patterns	array<string>	No
endpoint.subscribed_event_patterns[]	string	No
endpoint.signing_version	string	Yes
endpoint.secret_hint	string | null	No		nullable
endpoint.timeout_seconds	integer	Yes
endpoint.max_retries	integer	Yes
endpoint.consecutive_failures	integer	Yes
endpoint.last_verified_at	string | null	No		format=date-time, nullable
endpoint.last_delivery_at	string | null	No		format=date-time, nullable
endpoint.last_error	string | null	No		nullable
endpoint.created_at	string	Yes		format=date-time
endpoint.updated_at	string	Yes		format=date-time
secret	string	Yes

422

Validation Error

application/json

Resolved schema:

{
  "properties": {
    "detail": {
      "items": {
        "properties": {
          "loc": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "type": "array",
            "title": "Location"
          },
          "msg": {
            "type": "string",
            "title": "Message"
          },
          "type": {
            "type": "string",
            "title": "Error Type"
          }
        },
        "type": "object",
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "title": "ValidationError"
      },
      "type": "array",
      "title": "Detail"
    }
  },
  "type": "object",
  "title": "HTTPValidationError"
}

Field details:

Field	Type	Required	Description	Constraints
detail	array<object>	No
detail[]	object	No
detail[].loc	array<string | integer>	No
detail[].loc[]	string | integer	No
detail[].msg	string	No
detail[].type	string	No