> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cargado.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Register webhook endpoint

> Create a webhook endpoint for your organization. Cargado will POST event payloads to the
given URL, signed with the returned secret so you can verify authenticity.
The signing secret is only included in this response — store it securely.



## OpenAPI

````yaml /openapi.yml post /webhooks/endpoint/register
openapi: 3.1.0
info:
  title: Cargado API
  version: 1.0.0
  description: Cargado's API
  termsOfService: https://cargado.com/terms/
  contact:
    email: dev-support@cargado.com
servers:
  - url: https://api.cargado.com
    description: The production Cargado API server
security: []
tags:
  - name: Border Crossings
  - name: Loads
  - name: Rates
  - name: CarrierRelationship
  - name: User
  - name: Team
  - name: Webhooks
  - name: Bids
paths:
  /webhooks/endpoint/register:
    post:
      tags:
        - Webhooks
      summary: Register webhook endpoint
      description: >-
        Create a webhook endpoint for your organization. Cargado will POST event
        payloads to the

        given URL, signed with the returned secret so you can verify
        authenticity.

        The signing secret is only included in this response — store it
        securely.
      operationId: RegisterEndpoint
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegisterWebhookEndpointBody'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegisterWebhookEndpointResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                required:
                  - message
                type: object
      security:
        - apiKey: []
components:
  schemas:
    RegisterWebhookEndpointBody:
      properties:
        url:
          type: string
          description: The HTTPS URL where webhook payloads will be sent via POST
          pattern: ^https://
          examples:
            - https://api.example.com/webhooks
        description:
          type: string
          description: >-
            A label for this endpoint, visible in the dashboard and API
            responses
          maxLength: 256
          examples:
            - Production bid notifications
        filterTypes:
          items:
            $ref: '#/components/schemas/WebhookEventType'
          type: array
          description: >-
            Only deliver events matching these types. Omit to receive all event
            types.
          maxItems: 50
        channels:
          items:
            type: string
          type: array
          description: >-
            Channels to subscribe to (e.g. app installation IDs to scope
            delivery). Omit to receive events on all channels.
          maxItems: 50
        throttleRate:
          type:
            - integer
            - 'null'
          format: int32
          description: >-
            Max events per second delivered to this endpoint. Omit for
            unlimited.
          minimum: 1
          maximum: 1000
        disabled:
          type: boolean
          description: Set to true to create the endpoint in a paused state
        metadata:
          $ref: '#/components/schemas/Record_string.string_'
          description: >-
            Arbitrary key-value pairs to attach to this endpoint. Maximum 50
            entries.
        secret:
          type:
            - string
            - 'null'
          description: >-
            Provide your own signing secret. Omit to have one generated
            automatically.
          minLength: 1
          maxLength: 256
      required:
        - url
      type: object
      additionalProperties: true
    RegisterWebhookEndpointResponse:
      properties:
        endpoint:
          $ref: '#/components/schemas/WebhookEndpoint'
          description: The newly created endpoint
        secret:
          type: string
          description: >-
            Signing secret for verifying webhook payloads. Store this securely —
            it is only returned at registration time.
      required:
        - endpoint
        - secret
      type: object
      additionalProperties: true
    WebhookEventType:
      type: string
      enum:
        - bid.created
        - bid.accepted
        - bid.rejected
        - bid.revoked
        - bid.closed
        - bid.countered
        - bid.counter_accepted
        - bid.counter_revoked
        - bid.counter_rejected
      description: |-
        Event types available for webhook subscriptions.
        Use these values in `filterTypes` to receive only specific events.
    Record_string.string_:
      properties: {}
      additionalProperties:
        type: string
      type: object
      description: Construct a type with a set of properties K of type T
    WebhookEndpoint:
      properties:
        id:
          type: string
          description: Unique identifier for this endpoint
        url:
          type: string
          description: The HTTPS URL where webhook payloads are delivered
        description:
          type: string
          description: Label for this endpoint
        filterTypes:
          items:
            $ref: '#/components/schemas/WebhookEventType'
          type:
            - array
            - 'null'
          description: >-
            Event types this endpoint is subscribed to, or null if subscribed to
            all
        channels:
          items:
            type: string
          type:
            - array
            - 'null'
          description: Channels this endpoint listens on, or null if listening on all
        throttleRate:
          type:
            - number
            - 'null'
          format: double
          description: >-
            Max events per second delivered to this endpoint, or null for
            unlimited
        disabled:
          type: boolean
          description: Whether delivery to this endpoint is paused
        metadata:
          $ref: '#/components/schemas/Record_string.string_'
          description: Arbitrary key-value pairs attached to this endpoint
        createdAt:
          type: string
          description: ISO 8601 timestamp when the endpoint was created
        updatedAt:
          type: string
          description: ISO 8601 timestamp when the endpoint was last modified
      required:
        - id
        - url
        - description
        - filterTypes
        - channels
        - throttleRate
        - disabled
        - metadata
        - createdAt
        - updatedAt
      type: object
      additionalProperties: true
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: api-key

````