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

# Get webhook



## OpenAPI

````yaml /specs/management.yml get /webhooks/{webhookId}
openapi: 3.0.3
info:
  title: Smartcar Management API
  version: 3.0.0
  description: API for managing Smartcar applications.
servers:
  - url: https://management.api.smartcar.com/v3
security: []
paths:
  /webhooks/{webhookId}:
    get:
      summary: Get webhook
      operationId: getWebhook
      parameters:
        - in: path
          name: webhookId
          required: true
          schema:
            type: string
            format: uuid
          description: The unique identifier of the webhook
      responses:
        '200':
          description: The webhook resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookDataResource'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - bearerAuth: []
components:
  schemas:
    WebhookDataResource:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/WebhookResource'
    WebhookResource:
      type: object
      required:
        - id
        - type
        - attributes
        - links
        - meta
      properties:
        id:
          type: string
          format: uuid
        type:
          type: string
          enum:
            - webhook
        attributes:
          $ref: '#/components/schemas/WebhookAttributes'
        links:
          $ref: '#/components/schemas/WebhookResourceLinks'
          description: Related resource links for this webhook
        meta:
          $ref: '#/components/schemas/WebhookMeta'
    ErrorResponse1:
      type: object
      required:
        - errors
      properties:
        errors:
          type: array
          minItems: 1
          items:
            type: object
            required:
              - status
              - type
              - code
              - title
              - detail
            properties:
              status:
                type: string
              type:
                type: string
              code:
                type: string
              title:
                type: string
              detail:
                type: string
              resolution:
                type: object
                description: >-
                  Optional field providing guidance on how to resolve the error,
                  if applicable. The structure of this object can vary based on
                  the error type and is intended to provide actionable
                  information to clients.
              suggestedUserMessage:
                type: string
                description: >-
                  Optional field providing a user-friendly message that can be
                  displayed to end-users, if applicable. This message is
                  intended to be easily understandable and actionable for users
                  who encounter the error.
              links:
                type: object
                properties:
                  about:
                    type: string
                    format: uri
              meta:
                type: object
                properties:
                  debug:
                    type: object
                    description: >-
                      Debug information for internal use, not intended for
                      clients
                    properties:
                      applicationId:
                        type: string
                        description: The unique identifier for the application
                      requestId:
                        type: string
                        description: The unique identifier for the request
                      origin:
                        type: string
                        description: The origin of the error
                    example:
                      applicationId: app_123abc
                      requestId: req_456def
                      origin: internal.com/path
    WebhookAttributes:
      type: object
      required:
        - name
        - callbackUri
        - isEnabled
      properties:
        name:
          type: string
          description: Display name of the webhook
          example: Charging Webhook
        triggers:
          nullable: true
          type: array
          items:
            $ref: '#/components/schemas/SignalReference'
        data:
          type: array
          items:
            $ref: '#/components/schemas/SignalReference'
          nullable: true
          description: Data signal configuration for this webhook.
        callbackUri:
          type: string
          format: uri
          example: https://example.com/webhook
        errorCallbackUri:
          type: string
          format: uri
          nullable: true
          description: >-
            Callback URI for error notifications. Defaults to callbackUri if
            null.
          example: https://example.com/webhook/errors
        isEnabled:
          type: boolean
          description: Whether the webhook is currently enabled
          example: true
        autoSubscribe:
          type: boolean
          description: Whether the webhook automatically subscribes new vehicles
          example: false
    WebhookResourceLinks:
      type: object
      required:
        - self
      properties:
        self:
          type: string
          format: uri-reference
          description: Link to this webhook resource
          example: >-
            https://management.api.smartcar.com/v3/webhooks/4b4ddadf-3219-4a2e-9ed0-c4d0f6d4f7ca
    WebhookMeta:
      type: object
      required:
        - createdAt
      properties:
        createdAt:
          type: string
          format: date-time
          description: Timestamp when the webhook was created
    SignalReference:
      type: object
      required:
        - group
        - name
        - code
      properties:
        group:
          type: string
          example: SignalGroup
        name:
          type: string
          example: SignalName
        code:
          type: string
          example: signalCode
  responses:
    Unauthorized:
      description: 401 Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse1'
          example:
            errors:
              - status: '401'
                type: AUTHENTICATION
                code: UNAUTHORIZED
                title: Unauthorized
                detail: The Authorization token is missing or invalid.
                links:
                  about: >-
                    https://smartcar.com/docs/errors/api-errors/v3/authentication-errors#authentication
    Forbidden:
      description: 403 Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse1'
          example:
            errors:
              - status: '403'
                type: AUTHENTICATION
                code: FORBIDDEN
                title: Forbidden
                detail: You do not have permission to access this resource.
                links:
                  about: >-
                    https://smartcar.com/docs/errors/api-errors/v3/authentication-errors
    NotFound:
      description: 404 Not Found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse1'
          example:
            errors:
              - status: '404'
                type: RESOURCE_NOT_FOUND
                code: NOT_FOUND
                title: Not Found
                detail: The requested resource could not be found.
                links:
                  about: >-
                    https://smartcar.com/docs/errors/api-errors/v3/resource-not-found-errors
    InternalError:
      description: 500 Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse1'
          example:
            errors:
              - status: '500'
                type: SERVER
                code: INTERNAL
                title: Internal Server Error
                detail: An unexpected error occurred on the server.
                links:
                  about: https://smartcar.com/docs/errors/api-errors/v3/server-errors
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT or opaque
      description: |
        The Authorization header must be provided with a valid bearer token.
        Example: `Authorization: Bearer {token}`

````