EventHookInput

  • authConfig
    required
    • token
      Type: string
      required

      Bearer token

  • authType
    Type: string
    required

    Authentication type

  • endpointUrl
    Type: string
    min length:  
    1
    max length:  
    2083    Format: uri
    required

    Target HTTPS API endpoint URL

  • entityType
    Type: EntityTypeEnumenum
    required

    Entity type this hook applies to

    values
    dealscompaniespeopleleads
  • fieldMappings
    Type: Fieldmappings
    required

    Maps target API fields to source entity fields

    Properties: 1
  • name
    Type: string
    min length:  
    1
    max length:  
    255
    required

    Display name for the event hook

  • description
    Type: string
    max length:  
    1024    nullable

    Optional description

  • headers
    Type: Headersnullable

    Optional HTTP headers

    Properties: 1
  • httpMethod
    enum
    const:  
    POST

    HTTP method (currently only POST)

    values
    POST
  • timeoutSeconds
    Type: integer
    min:  
    1

    Request timeout in seconds

  • valueMappings
    Type: Valuemappingsnullable

    Maps CRM field values to API values

    Properties: 1
  • propertyName
    additionalPropertyType: anything