> ## Documentation Index > Fetch the complete documentation index at: https://docs.alvys.com/llms.txt > Use this file to discover all available pages before exploring further. # Create webhook subscription > Creates a new webhook subscription. **Note:** You must verify the HMAC-SHA256 signature using the raw request body. Creates a new webhook subscription. **Note:** You must verify the HMAC-SHA256 signature using the raw request body. ## OpenAPI ````yaml POST /api/p/v{version}/webhooks openapi: 3.0.1 info: title: Alvys description: >- Alvys provides a robust set of REST APIs to allow you to integrate Alvys into virtually any platform. These APIs cover most of Alvys' major product areas with additional endpoints being added regularly based on customer requests. contact: name: Alvys Support url: https://www.alvys.com/resources/contact/ version: v1 servers: - url: https://integrations.alvys.com description: Public API Server - url: https://api.alvys.com/ description: Public API Server security: - Public: [] tags: - name: Authentication description: Obtain an OAuth 2.0 access token for the Alvys Public API. - name: Carrier Settlement Statements description: >- Search carrier settlement statements and retrieve a single statement by number. - name: Carriers description: Read carrier records, search carriers, and manage carrier documents. - name: Customers description: Create, read, update, delete, and search customer records. - name: Deductions description: >- Create one-time deductions and search or delete existing deduction records. - name: DispatchPreferences description: Dispatch preferences endpoints for reading dispatch rules and preferences. - name: Driver Settlement Statements description: >- Search driver settlement statements and retrieve a single statement by number. - name: Drivers description: >- Read driver records, search drivers and driver events, and manage driver documents. - name: Fuel description: Read and search fuel transactions. - name: Invoices description: >- Read invoices, create carrier invoices, and record carrier and customer payments. - name: Loads description: Read, update, search loads, and manage load documents and notes. - name: Locations description: Read and search company location details. - name: Maintenance description: Read and search maintenance records. - name: Tenders description: Create, accept, reject, cancel, update, and search inbound EDI tenders. - name: Tolls description: Read and search toll transactions. - name: Trailers description: Read trailers, search trailer events, and manage trailer documents. - name: Trips description: >- Read, search trips, manage trip documents, and record stop appointments, arrivals, and departures. - name: Trucks description: Read trucks, search truck events, and manage truck documents. - name: Users description: List and search users. - name: Visibility description: >- Read inbound and outbound visibility history and search outbound visibility errors. - name: Webhooks description: >- Create, read, update, delete, enable, disable, verify, test, and rotate secrets for webhook subscriptions; read event types, delivery logs, and health metrics. paths: /api/p/v{version}/webhooks: post: tags: - Webhooks summary: Create webhook subscription description: >- Creates a new webhook subscription. **Note:** You must verify the HMAC-SHA256 signature using the raw request body. parameters: - name: version in: path description: API version (e.g., 1.0) required: true schema: type: string default: '1.0' example: '1.0' requestBody: content: application/json-patch+json: schema: allOf: - $ref: >- #/components/schemas/Alvys.Models.Webhooks.CreateWebhookRequest application/json: schema: allOf: - $ref: >- #/components/schemas/Alvys.Models.Webhooks.CreateWebhookRequest text/json: schema: allOf: - $ref: >- #/components/schemas/Alvys.Models.Webhooks.CreateWebhookRequest application/*+json: schema: allOf: - $ref: >- #/components/schemas/Alvys.Models.Webhooks.CreateWebhookRequest required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/Alvys.Models.Webhooks.WebhookResponse' '400': description: Bad Request content: application/json: schema: $ref: >- #/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' application/problem+json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' application/problem+json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' '409': description: Conflict content: application/json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' '429': description: Too Many Requests content: application/problem+json: schema: $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails' security: - Public: [] components: schemas: Alvys.Models.Webhooks.CreateWebhookRequest: required: - Events - Name - SubsidiaryId - Url - IncludePreviousAttributes type: object properties: Name: minLength: 1 type: string SubsidiaryId: minLength: 1 type: string Url: maxLength: 2048 minLength: 1 type: string Events: type: array items: type: string IncludePreviousAttributes: type: boolean additionalProperties: false Alvys.Models.Webhooks.WebhookResponse: required: - CompanyCode - ConsecutiveFailures - CreatedAt - CreatedBy - Events - Id - Name - Secret - Status - SubsidiaryId - Url - IncludePreviousAttributes type: object properties: Id: type: string CompanyCode: type: string SubsidiaryId: type: string Name: type: string Url: type: string Secret: type: string Events: type: array items: type: string Status: type: string DisabledAt: type: string format: date-time nullable: true DisabledReason: type: string nullable: true ConsecutiveFailures: type: integer format: int32 CreatedAt: type: string format: date-time CreatedBy: type: string UpdatedAt: type: string format: date-time nullable: true UpdatedBy: type: string nullable: true LastTriggeredAt: type: string format: date-time nullable: true IncludePreviousAttributes: type: boolean additionalProperties: false Microsoft.AspNetCore.Mvc.ValidationProblemDetails: required: - Errors type: object properties: Errors: type: object additionalProperties: type: array items: type: string Type: type: string nullable: true Title: type: string nullable: true Status: type: integer format: int32 nullable: true Detail: type: string nullable: true Instance: type: string nullable: true additionalProperties: {} Microsoft.AspNetCore.Mvc.ProblemDetails: type: object properties: Type: type: string nullable: true Title: type: string nullable: true Status: type: integer format: int32 nullable: true Detail: type: string nullable: true Instance: type: string nullable: true additionalProperties: {} securitySchemes: Public: type: http scheme: bearer bearerFormat: JWT description: >- OAuth 2.0 client-credentials access token. Obtain one from https://auth.alvys.com/oauth/token (grant_type=client_credentials, audience=https://api.alvys.com/public/), then paste it here. The playground sends it as `Authorization: Bearer `. ````