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

# Create an event subscription

> Créer un nouvel abonnement aux événements pour l'application spécifiée.

> **Supported products**


## OpenAPI

````yaml specs/legacy/v3/webhooks-webhooks-v3.json POST /webhooks/v3/{appId}/subscriptions
openapi: 3.0.1
info:
  title: Webhooks Webhooks
  description: >-
    Provides a way for apps to subscribe to certain change events in HubSpot.
    Once configured, apps will receive event payloads containing details about
    the changes at a specified target URL. There can only be one target URL for
    receiving event notifications per app.
  version: v3
  x-hubspot-product-tier-requirements:
    marketing: FREE
    sales: FREE
    service: FREE
    cms: FREE
    commerce: FREE
    crmHub: FREE
    dataHub: FREE
  x-hubspot-related-documentation:
    - name: Webhooks Guide
      url: https://developers.hubspot.com/docs/guides/api/webhooks/overview
servers:
  - url: https://api.hubapi.com
security: []
tags:
  - name: Basic
  - name: Batch
paths:
  /webhooks/v3/{appId}/subscriptions:
    post:
      tags:
        - Basic
      summary: Créer un abonnement à un événement
      description: Créer un nouvel abonnement aux événements pour l'application spécifiée.
      operationId: post-/webhooks/v3/{appId}/subscriptions_create
      parameters:
        - name: appId
          in: path
          description: L'ID de l'application cible.
          required: true
          style: simple
          explode: false
          schema:
            type: integer
            format: int32
      requestBody:
        description: Details about the new subscription.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubscriptionCreateRequest'
        required: true
      responses:
        '201':
          description: successful operation
          headers:
            Location:
              description: URL of the newly created resource
              style: simple
              explode: false
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionResponse'
              example:
                active: true
                createdAt: '2019-10-30T03:30:17.883Z'
                eventType: contact.propertyChange
                id: '12'
                propertyName: email
                updatedAt: '2019-11-30T03:30:17.883Z'
        default:
          $ref: '#/components/responses/Error'
          description: ''
      security:
        - developer_hapikey: []
components:
  schemas:
    SubscriptionCreateRequest:
      required:
        - eventType
      type: object
      properties:
        active:
          type: boolean
          description: >-
            Détermine si l'abonnement est actif ou en pause. Par défaut, il est
            faux.
        eventType:
          type: string
          description: "Type d'événement auxquels être attentifs\_: «\_create\_» «\_delete\_» «\_deletedForPrivacy\_» «\_propertyChange\_»"
          enum:
            - company.associationChange
            - company.creation
            - company.deletion
            - company.merge
            - company.propertyChange
            - company.restore
            - contact.associationChange
            - contact.creation
            - contact.deletion
            - contact.merge
            - contact.privacyDeletion
            - contact.propertyChange
            - contact.restore
            - conversation.creation
            - conversation.deletion
            - conversation.newMessage
            - conversation.privacyDeletion
            - conversation.propertyChange
            - deal.associationChange
            - deal.creation
            - deal.deletion
            - deal.merge
            - deal.propertyChange
            - deal.restore
            - event.completed
            - line_item.associationChange
            - line_item.creation
            - line_item.deletion
            - line_item.merge
            - line_item.propertyChange
            - line_item.restore
            - object.associationChange
            - object.creation
            - object.deletion
            - object.merge
            - object.propertyChange
            - object.restore
            - product.creation
            - product.deletion
            - product.merge
            - product.propertyChange
            - product.restore
            - ticket.associationChange
            - ticket.creation
            - ticket.deletion
            - ticket.merge
            - ticket.propertyChange
            - ticket.restore
        eventTypeName:
          type: string
          description: >-
            Le nom de l'évènement à écouter. Il est utilisé avec des objets
            personnalisés pour spécifier des types d'évènements personnalisés
            au-delà des valeurs d'énumération eventType standard.
        objectTypeId:
          type: string
          description: >-
            L'ID du type d'objet pour l'abonnement. Il peut s'agir d'un objet
            CRM standard (par exemple, « contact », « entreprise », «
            transaction ») ou d'un ID d'objet personnalisé pour les abonnements
            à des objets personnalisés.
        propertyName:
          type: string
          description: "Le nom interne de la propriété à surveiller pour les changements. S'applique uniquement lorsque «\_eventType\_» est «\_propertyChange\_»."
      description: >-
        Request to create a new webhook subscription for monitoring specific
        events. Each subscription defines which event type to listen for and
        whether to monitor all events of that type or specific property changes.
      example:
        active: true
        eventType: contact.propertyChange
        propertyName: email
    SubscriptionResponse:
      required:
        - active
        - createdAt
        - eventType
        - id
      type: object
      properties:
        active:
          type: boolean
          description: "Indique si l'abonnement est actif ou suspendu. Si la valeur est «\_true\_», l'abonnement enverra des notifications de webhook. Si la valeur est «\_false\_», l'abonnement sera suspendu et n'enverra pas de notifications."
        createdAt:
          type: string
          description: >-
            L'horodatage de la création de l'abonnement au webhook, au format
            ISO 8601 (par exemple, 2020-02-29T12:30:00Z).
          format: date-time
        eventType:
          type: string
          description: >-
            Le type d'évènement à écouter. Les valeurs acceptées incluent
            contact.creation, contact.deletion, contact.propertyChange et des
            types d'évènements similaires pour d'autres objets CRM et objets
            personnalisés.
          enum:
            - company.associationChange
            - company.creation
            - company.deletion
            - company.merge
            - company.propertyChange
            - company.restore
            - contact.associationChange
            - contact.creation
            - contact.deletion
            - contact.merge
            - contact.privacyDeletion
            - contact.propertyChange
            - contact.restore
            - conversation.creation
            - conversation.deletion
            - conversation.newMessage
            - conversation.privacyDeletion
            - conversation.propertyChange
            - deal.associationChange
            - deal.creation
            - deal.deletion
            - deal.merge
            - deal.propertyChange
            - deal.restore
            - event.completed
            - line_item.associationChange
            - line_item.creation
            - line_item.deletion
            - line_item.merge
            - line_item.propertyChange
            - line_item.restore
            - object.associationChange
            - object.creation
            - object.deletion
            - object.merge
            - object.propertyChange
            - object.restore
            - product.creation
            - product.deletion
            - product.merge
            - product.propertyChange
            - product.restore
            - ticket.associationChange
            - ticket.creation
            - ticket.deletion
            - ticket.merge
            - ticket.propertyChange
            - ticket.restore
        eventTypeName:
          type: string
          description: >-
            Le nom de l'évènement à écouter. Il est utilisé avec des objets
            personnalisés pour spécifier des types d'évènements personnalisés
            au-delà des valeurs d'énumération eventType standard.
        id:
          type: string
          description: L'ID unique de l'abonnement au webhook.
        objectTypeId:
          type: string
          description: >-
            L'ID du type d'objet pour l'abonnement. Il peut s'agir d'un objet
            CRM standard (par exemple, « contact », « entreprise », «
            transaction ») ou d'un ID d'objet personnalisé pour les abonnements
            à des objets personnalisés.
        propertyName:
          type: string
          description: >-
            Le nom interne de la propriété à surveiller pour les changements.
            S'applique uniquement lorsque eventType est propertyChange.
        updatedAt:
          type: string
          description: >-
            L'horodatage de la dernière mise à jour de l'abonnement au webhook,
            au format ISO 8601 (par exemple, 2020-02-29T12:30:00Z).
          format: date-time
      description: Complete details for an event subscription.
    Error:
      required:
        - category
        - correlationId
        - message
      type: object
      properties:
        category:
          type: string
          description: >-
            La catégorie d'erreur, représentée sous forme de chaine de
            caractères.
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: >-
            Un objet contenant le contexte concernant la condition d'erreur.
            Cela inclut des propriétés supplémentaires, chacune étant un tableau
            de chaînes.
          example: >-
            {invalidPropertyName=[propertyValue], missingScopes=[scope1,
            scope2]}
        correlationId:
          type: string
          description: >-
            Un identifiant unique pour la demande, formaté en UUID. Incluez
            cette valeur dans tous les rapports d'erreur ou tickets
            d'assistance.
          format: uuid
          example: aeb5f871-7f07-4993-9211-075dc63e7cbf
        errors:
          type: array
          description: >-
            Un tableau fournissant des informations supplémentaires sur
            l'erreur. Chaque élément du tableau est un objet ErrorDetail.
          items:
            $ref: '#/components/schemas/ErrorDetail'
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Une carte des noms de liens vers les URI associées contenant de la
            documentation sur l'erreur ou les étapes de correction recommandées.
            Il s'agit d'un objet avec des propriétés de chaîne.
        message:
          type: string
          description: >-
            Un message lisible par l'utilisateur décrivant l'erreur et les
            mesures correctives à prendre, le cas échéant. Il s'agit d'une
            chaîne.
          example: An error occurred
        subCategory:
          type: string
          description: >-
            Une catégorie spécifique qui fournit des informations plus
            détaillées sur l'erreur. Il s'agit d'une chaîne.
      description: >-
        Représente une réponse d'erreur renvoyée par l'API lorsqu'une opération
        échoue. Ce composant est utilisé dans divers points de terminaison pour
        fournir des informations détaillées sur l'erreur rencontrée.
      example:
        message: Invalid input (details will vary based on the error)
        correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf
        category: VALIDATION_ERROR
        links:
          knowledge-base: https://www.hubspot.com/products/service/knowledge-base
    ErrorDetail:
      required:
        - message
      type: object
      properties:
        code:
          type: string
          description: Le code d'état associé au détail de l'erreur.
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: >-
            Contexte de la condition d'erreur, fourni sous la forme d'un objet
            avec des propriétés supplémentaires.
          example: '{missingScopes=[scope1, scope2]}'
        in:
          type: string
          description: Le nom du champ ou du paramètre dans lequel l'erreur a été trouvée.
        message:
          type: string
          description: >-
            Un message lisible par la personne décrivant l'erreur ainsi que les
            étapes de remédiation appropriées, le cas échéant.
        subCategory:
          type: string
          description: >-
            Une catégorie spécifique qui contient des détails plus précis sur
            l'erreur.
      description: >-
        Représente des informations détaillées sur une erreur survenue dans
        l'API. Ce composant est utilisé pour fournir un contexte et des
        spécificités supplémentaires sur les erreurs, généralement dans le cadre
        d'une réponse d'erreur.
  responses:
    Error:
      description: An error occurred.
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    developer_hapikey:
      type: apiKey
      name: hapikey
      in: query

````