> ## Documentation Index > Fetch the complete documentation index at: https://docs.brelio.com/llms.txt > Use this file to discover all available pages before exploring further. # Create webhook > Registers an https URL that receives signed notices when the chosen events happen. **When to use it:** So another system (n8n, Zapier, your own server) learns about changes without polling the API. ## OpenAPI ````yaml /api-reference/openapi.en.json post /webhooks openapi: 3.1.0 info: title: Brelio API version: '1' description: >- Everything a person can do in Brelio, a program can do, with the same permissions, audit and limits. Every endpoint is derived from the operation catalogue. servers: - url: https://api.brelio.app/v1 security: [] paths: /webhooks: post: tags: - webhooks summary: Create webhook description: >- Registers an https URL that receives signed notices when the chosen events happen. **When to use it:** So another system (n8n, Zapier, your own server) learns about changes without polling the API. operationId: webhooks.create parameters: - name: Idempotency-Key in: header required: true schema: type: string minLength: 8 maxLength: 255 description: Unique per command; reuse it only to retry the same call. requestBody: required: true content: application/json: schema: type: object properties: url: type: string maxLength: 2048 description: 'Your endpoint: https to a public host name.' description: type: string maxLength: 500 eventTypes: minItems: 1 maxItems: 100 type: array items: type: string minLength: 1 maxLength: 200 description: Event types to receive, from GET /v1/webhook-event-types. required: - url - eventTypes examples: example1: summary: Test notices value: url: https://hooks.example.com/brelio eventTypes: - webhookEndpoint.tested responses: '201': description: Success content: application/json: schema: type: object properties: id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ url: type: string description: anyOf: - type: string - type: 'null' eventTypes: type: array items: type: string status: type: string enum: - enabled - disabled secretHint: type: string description: The last characters of the signing secret. secretCreatedAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ description: ISO 8601, UTC. previousSecretExpiresAt: anyOf: - type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ description: ISO 8601, UTC. - type: 'null' description: >- Until then deliveries also carry a signature with the secret replaced by the last rotation. failingSince: anyOf: - type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ description: ISO 8601, UTC. - type: 'null' description: >- First failed attempt since the last delivery that got through. disablesAt: anyOf: - type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ description: ISO 8601, UTC. - type: 'null' description: >- When the endpoint is disabled if no delivery gets through before; null while it works. disabledAt: anyOf: - type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ description: ISO 8601, UTC. - type: 'null' createdBy: type: string version: type: integer minimum: -9007199254740991 maximum: 9007199254740991 createdAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ description: ISO 8601, UTC. updatedAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ description: ISO 8601, UTC. secret: description: >- Signing secret (`whsec_…`), in the response that created it only. Store it now: Brelio cannot show it again. type: string required: - id - url - description - eventTypes - status - secretHint - secretCreatedAt - previousSecretExpiresAt - failingSince - disablesAt - disabledAt - createdBy - version - createdAt - updatedAt additionalProperties: false '401': description: Problem Details (RFC 9457) with a stable `code` content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '402': description: Problem Details (RFC 9457) with a stable `code` content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '403': description: Problem Details (RFC 9457) with a stable `code` content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '422': description: Problem Details (RFC 9457) with a stable `code` content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '429': description: Problem Details (RFC 9457) with a stable `code` content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '503': description: Problem Details (RFC 9457) with a stable `code` content: application/problem+json: schema: $ref: '#/components/schemas/Problem' security: - bearer: [] components: schemas: Problem: type: object required: - type - title - status - code - detail - request_id - params properties: type: type: string title: type: string status: type: integer code: type: string detail: type: string request_id: type: string hint: type: string retryAfterSeconds: type: integer params: type: object securitySchemes: bearer: type: http scheme: bearer description: Brelio API key (organization or user) or a WorkOS access token. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.