indigitall Customer Service Webhook Template API

openapi: 3.2.0
info:
  version: 2.0.0
  title: INDIGITALL Customer Service Webhook Template API
  x-logo:
    url: https://console.indigitall.com/images/logo_verdeblanco@2x.png
    backgroundColor: '#0F3B7A'
  description: '### Introduction:

    This documentation describes every endpoint of Indigitall''s API v2


    API BASE URL: https://api.indigitall.com/v2


    ### Authentication:


    Most of the endpoints of the API needs an Authorization header.


    There are two Authorization ways:


    - If your intention is to manage API calls with a server-side script you have to create a Server key through Indigitall''s console.


    You can set the following Authorization Header : ''Authorization: ServerKey {ServerKey}''

    - If your intention is to integrate this API for front-end users POST /auth endpoint authorizes a user and returns an access token.


    You can set the following Authorization Header : ''Authorization: Bearer {Token}'''
servers:
- url: https://api.indigitall.com/v2
security:
- Authorization: []
tags:
- name: customer-service-webhook-template
  x-displayName: Customer service - Webhook Template
  description: Customer service endpoints
paths:
  /cs/webhooktemplate:
    get:
      tags:
      - customer-service-webhook-template
      summary: Get all webhook templates
      x-eov-operation-handler: webhookTemplateController
      x-gateway-endpoint: customerService
      operationId: csGetAllWebhookTemplates
      parameters:
      - name: applicationId
        in: query
        description: customer application id
        required: true
        schema:
          type: number
      - in: query
        name: limit
        required: false
        description: results per page
        schema:
          type: integer
          default: 100
      - in: query
        name: page
        required: false
        description: filter by page
        schema:
          type: integer
          minimum: 0
          default: 0
      - in: query
        name: find
        required: false
        description: filter by name, url
        schema:
          type: string
      - in: query
        name: orderBy
        required: false
        description: "Order of the results:\n\n  * a-z - Order by name ascending. From A to Z.\n  * z-a - Order by name descending. From Z to A.\n  * 1-9 - Order by id ascending.\n  * 9-1 - Order by id descending.\n  * Date ascending - Order by created_at ascending.\n  * Date descending - Order by created_at descending.\n"
        schema:
          type: string
          enum:
          - a-z
          - z-a
          - 1-9
          - 9-1
          - Date ascending
          - Date descending
          default: Date descending
      - in: query
        name: reqType
        required: false
        description: filters by request type
        schema:
          type: string
          enum:
          - POST
          - GET
          - PUT
          - DELETE
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CS_WebhookTemplateListResponse'
        '400':
          $ref: '#/components/responses/CS_BadRequestResponse'
        '403':
          $ref: '#/components/responses/CS_Forbidden'
        '500':
          $ref: '#/components/responses/CS_ServerErrorResponse'
        default:
          description: Error 5XX, 4XX
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CS_ErrorSchema'
    post:
      tags:
      - customer-service-webhook-template
      summary: Creates a webhook template
      description: 'Creates a webhook template entity associated to a journey. The webhook allows dynamic content using the Liquid templating language.


        Some parts of the webhook (`url`, `reqHeaders`, `reqBody`, `reqQueryParams`) support Liquid syntax.


        You can use the following variables in the template:

        - `customer.`: Custom fields from the customer (e.g. `{{customer.email}}`)

        - `context.`: Contextual information passed to the journey (e.g. `{{context.language}}`)

        - Reserved variables:

        - `customerId`: Customer external code

        - `journeyId`: Current journey ID

        - `stateId`: Current state ID

        - `concurrencyExecutionId`: Concurrency execution ID

        - `customerJourneyId`: Customer journey ID'
      x-eov-operation-handler: webhookTemplateController
      x-gateway-endpoint: customerService
      operationId: csPostWebhookTemplate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CS_WebhookTemplatePostRequest'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CS_WebhookTemplateResponse'
        '400':
          $ref: '#/components/responses/CS_BadRequestResponse'
        '403':
          $ref: '#/components/responses/CS_Forbidden'
        '404':
          description: Customer journey not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CS_ErrorSchema'
              example:
                statusCode: 404
                errorCode: CS_CUSTOMER_JOURNEY_NOT_FOUND
                message: Customer journey not found
        '500':
          $ref: '#/components/responses/CS_ServerErrorResponse'
        default:
          description: Error 5XX, 4XX
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CS_ErrorSchema'
  /cs/webhooktemplate/{id}:
    delete:
      tags:
      - customer-service-webhook-template
      summary: Delete one webhook template by id
      x-eov-operation-handler: webhookTemplateController
      x-gateway-endpoint: customerService
      operationId: csDeleteWebhookTemplate
      parameters:
      - in: path
        name: id
        schema:
          type: number
        required: true
        description: Numeric ID of the webhook template to get
      - name: applicationId
        in: query
        description: customer application id
        required: true
        schema:
          type: number
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CS_WebhookTemplateResponse'
        '400':
          $ref: '#/components/responses/CS_BadRequestResponse'
        '403':
          $ref: '#/components/responses/CS_Forbidden'
        '404':
          description: Customer webhook template not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CS_ErrorSchema'
              example:
                statusCode: 404
                errorCode: CS_CUSTOMER_JOURNEY_TEMPLATE_NOT_FOUND
                message: Customer webhook template not found
        '500':
          $ref: '#/components/responses/CS_ServerErrorResponse'
        default:
          description: Error 5XX, 4XX
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CS_ErrorSchema'
    get:
      tags:
      - customer-service-webhook-template
      summary: Gets one webhook template by id
      x-eov-operation-handler: webhookTemplateController
      x-gateway-endpoint: customerService
      operationId: csGetWebhookTemplate
      parameters:
      - in: path
        name: id
        schema:
          type: number
        required: true
        description: Numeric ID of the webhook template to get
      - name: applicationId
        in: query
        description: customer application id
        required: true
        schema:
          type: number
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CS_WebhookTemplateResponse'
        '400':
          $ref: '#/components/responses/CS_BadRequestResponse'
        '403':
          $ref: '#/components/responses/CS_Forbidden'
        '404':
          description: Customer webhook template not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CS_ErrorSchema'
              example:
                statusCode: 404
                errorCode: CS_CUSTOMER_JOURNEY_TEMPLATE_NOT_FOUND
                message: Customer webhook template not found
        '500':
          $ref: '#/components/responses/CS_ServerErrorResponse'
        default:
          description: Error 5XX, 4XX
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CS_ErrorSchema'
    put:
      tags:
      - customer-service-webhook-template
      summary: Update one webhook template by id
      description: 'Update one webhook template by id. The webhook allows dynamic content using the Liquid templating language.


        Some parts of the webhook (`url`, `reqHeaders`, `reqBody`, `reqQueryParams`) support Liquid syntax.


        You can use the following variables in the template:

        - `customer.`: Custom fields from the customer (e.g. `{{customer.email}}`)

        - `context.`: Contextual information passed to the journey (e.g. `{{context.language}}`)

        - Reserved variables:

        - `customerId`: Customer external code

        - `journeyId`: Current journey ID

        - `stateId`: Current state ID

        - `concurrencyExecutionId`: Concurrency execution ID'
      x-eov-operation-handler: webhookTemplateController
      x-gateway-endpoint: customerService
      operationId: csPutWebhookTemplate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CS_WebhookTemplatePutRequest'
        required: true
      parameters:
      - in: path
        name: id
        schema:
          type: number
        required: true
        description: Numeric ID of the webhook template to get
      - name: applicationId
        in: query
        description: customer application id
        required: true
        schema:
          type: number
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CS_WebhookTemplateResponse'
        '400':
          $ref: '#/components/responses/CS_BadRequestResponse'
        '403':
          $ref: '#/components/responses/CS_Forbidden'
        '404':
          description: Webhook template not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CS_ErrorSchema'
              example:
                statusCode: 404
                errorCode: CS_WEBHOOK_TEMPLATE_NOT_FOUND
                message: Webhook template not found
        '500':
          $ref: '#/components/responses/CS_ServerErrorResponse'
        default:
          description: Error 5XX, 4XX
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CS_ErrorSchema'
  /cs/webhooktemplate/{id}/simulate:
    post:
      tags:
      - customer-service-webhook-template
      summary: Simulate webhook execution with given context
      description: Simulates a webhook request by rendering the template with the provided context. Sends a test request to the webhook URL with rendered URL, headers, query params, and body.
      x-eov-operation-handler: webhookTemplateController
      x-gateway-endpoint: customerService
      operationId: csPostWebhookTemplateSimulate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CS_WebhookTemplateSimulatePostRequest'
        required: true
      parameters:
      - in: path
        name: id
        schema:
          type: number
        required: true
        description: Numeric ID of the webhook template to get
      - name: applicationId
        in: query
        description: customer application id
        required: true
        schema:
          type: number
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CS_WebhookTemplateVariablesResponse'
        '400':
          $ref: '#/components/responses/CS_BadRequestResponse'
        '403':
          $ref: '#/components/responses/CS_Forbidden'
        '404':
          description: Customer webhook template not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CS_ErrorSchema'
              example:
                statusCode: 404
                errorCode: CS_CUSTOMER_JOURNEY_TEMPLATE_NOT_FOUND
                message: Customer webhook template not found
        '500':
          $ref: '#/components/responses/CS_ServerErrorResponse'
        default:
          description: Error 5XX, 4XX
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CS_ErrorSchema'
  /cs/webhooktemplate/{id}/variables:
    get:
      tags:
      - customer-service-webhook-template
      summary: Get variables from webhook template components
      description: Retrieves all variables used within the webhook template components identified by {id}, including the URL, query parameters (reqQueryParams), request body (reqBody), and request headers (reqHeaders). This endpoint detects all variables written using the Liquid Template Language syntax in these fields and returns an array containing the paths of each found variable.
      x-eov-operation-handler: webhookTemplateController
      x-gateway-endpoint: customerService
      operationId: csGetWebhookTemplateVariables
      parameters:
      - in: path
        name: id
        schema:
          type: number
        required: true
        description: Numeric ID of the webhook template to get
      - name: applicationId
        in: query
        description: customer application id
        required: true
        schema:
          type: number
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CS_WebhookTemplateVariablesResponse'
        '400':
          $ref: '#/components/responses/CS_BadRequestResponse'
        '403':
          $ref: '#/components/responses/CS_Forbidden'
        '404':
          description: Customer webhook template not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CS_ErrorSchema'
              example:
                statusCode: 404
                errorCode: CS_CUSTOMER_JOURNEY_TEMPLATE_NOT_FOUND
                message: Customer webhook template not found
        '500':
          $ref: '#/components/responses/CS_ServerErrorResponse'
        default:
          description: Error 5XX, 4XX
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CS_ErrorSchema'
components:
  responses:
    CS_Forbidden:
      description: Operation forbidden for your user
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CS_ErrorSchema'
          example:
            statusCode: 403
            errorCode: CS_FORBIDDEN
            message: Operation forbidden
    CS_ServerErrorResponse:
      description: Server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CS_ErrorSchema'
          example:
            statusCode: 500
            errorCode: CS_SERVER_ERROR
            message: Server error
    CS_BadRequestResponse:
      description: Parameter is missing or invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CS_ErrorSchema'
          example:
            statusCode: 400
            errorCode: CS_PARAMETER_MISSING_OR_INVALID
            message: Parameter is missing or invalid
  schemas:
    CS_WebhookTemplatePutRequest:
      description: Schema for update a Webhook template
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          description: Name for webhook template
        url:
          type: string
          description: Url used for webhook. (Accepts Liquid Template Language)
        reqType:
          description: Request type
          type: string
          enum:
          - POST
          - GET
          - PUT
          - DELETE
        reqHeaders:
          description: object key values for headers request. (Accepts Liquid Template Language)
          type:
          - object
          - 'null'
        reqQueryParams:
          description: object key values for query params request. (Accepts Liquid Template Language in values)
          type:
          - object
          - 'null'
        reqBody:
          description: Body of the request. Accepts Liquid Template Language in values.
          type:
          - string
          - 'null'
    CS_WebhookTemplateListResponse:
      type: object
      properties:
        statusCode:
          type: integer
          description: Response code
        message:
          type: string
          description: Response message, usually OK
        count:
          type: integer
          description: Number of records
        data:
          type: array
          items:
            $ref: '#/components/schemas/CS_WebhookTemplateObject'
    CS_WebhookTemplateVariablesResponse:
      required:
      - data
      - message
      - statusCode
      type: object
      properties:
        statusCode:
          type: integer
          description: Response code
        message:
          type: string
          description: Response message, usually OK
        data:
          type: object
          properties:
            variablePaths:
              type: array
              description: Array of variable paths found in the webhook template
              items:
                type: string
    CS_WebhookTemplateResponse:
      required:
      - data
      - message
      - statusCode
      type: object
      properties:
        statusCode:
          type: integer
          description: Response code
        message:
          type: string
          description: Response message, usually OK
        data:
          $ref: '#/components/schemas/CS_WebhookTemplateObject'
    CS_WebhookTemplatePostRequest:
      description: Schema for create a new Webhook template
      type: object
      required:
      - applicationId
      - url
      - reqType
      - reqContentType
      properties:
        name:
          type: string
          description: Name for webhook template
        applicationId:
          type: number
          description: application id
        url:
          type: string
          description: Url used for webhook. (Accepts Liquid Template Language)
        reqType:
          description: Request type
          type: string
          enum:
          - POST
          - GET
          - PUT
          - DELETE
        reqContentType:
          description: Request content type. Currently only supports application/json.
          type: string
          default: application/json
          enum:
          - application/json
        reqHeaders:
          description: object key values for headers request. (Accepts Liquid Template Language)
          type:
          - object
          - 'null'
        reqQueryParams:
          description: object key values for query params request. (Accepts Liquid Template Language in values)
          type:
          - object
          - 'null'
        reqBody:
          description: Body of the request. Accepts Liquid Template Language in values.
          type:
          - string
          - 'null'
    CS_WebhookTemplateSimulatePostRequest:
      description: Schema for simulate a Webhook template
      type: object
      properties:
        contextTemplate:
          type: object
          description: Context templte object to render the Liquid templates in the webhook components.
    CS_WebhookTemplateObject:
      type: object
      properties:
        id:
          type: integer
          description: webhook template identifier
        name:
          type:
          - string
          - 'null'
          description: Name for webhook template
        applicationId:
          type: number
          description: application id
        url:
          type: string
          description: Url used for webhook. (Accepts Liquid Template Language)
        reqType:
          description: Request type
          type: string
        reqContentType:
          description: Request content type. Currently only supports application/json.
          type: string
        reqHeaders:
          description: object key values for headers request. (Accepts Liquid Template Language)
          type:
          - object
          - 'null'
        reqQueryParams:
          description: object key values for query params request. (Accepts Liquid Template Language in values)
          type:
          - object
          - 'null'
        reqBody:
          description: Body of the request. Accepts Liquid Template Language in values.
          type:
          - string
          - 'null'
    CS_ErrorSchema:
      required:
      - message
      - statusCode
      type: object
      properties:
        statusCode:
          type: integer
          description: Response code
        errorCode:
          type: string
          enum:
          - CS_CUSTOMER_NOT_ENABLED
          - CS_CUSTOMER_NOT_FOUND
          - CS_CUSTOMER_ID_IN_USE
          - CS_CUSTOMER_WITH_NO_FIELDS
          - CS_CUSTOMER_BAD_FORMAT_FIELD
          - CS_CUSTOMERS_NOT_FOUND
          - CS_CUSTOMERS_HAVE_ERRORS
          - CS_CUSTOMERS_SOME_HAVE_ERRORS
          - CS_APPLICATION_WITH_NO_FIELDS
          - CS_CUSTOMER_FIELD_ALREADY_EXISTS
          - CS_INVALID_CUSTOMER_FIELD_NAME
          - CS_CUSTOMER_FIELD_NOT_FOUND
          - CS_API_GATEWAY_TOKEN_NOT_VALID
          - CS_ERROR_PROCESSING_GATEWAY_TOKEN
          - CS_AUTHORIZATION_FORMAT_ERROR
          - CS_NOT_VALID_IP
          - CS_NOT_VALID_KEY
          - CS_SERVER_ERROR
          - CS_TOO_MANY_REQUEST
          - CS_CAMPAING_ID_NOT_FOUND
          - CS_CSV_FORMAT_NOT_SUPPORTED
          - CS_CSV_WITH_NO_CUSTOMERS
          - CS_CSV_WITH_NO_CUSTOMER_ID_FIELD
          - CS_CSV_WITH_NO_CUSTOMER_FIELDS
          - CS_INCORRECT_SCHEDULE_AT_DATE
          - CS_CUSTOMER_JOURNEY_NOT_FOUND
          - CS_CUSTOMER_JOURNEY_TEMPLATE_NOT_FOUND
          - CS_CUSTOMER_JOURNEY_TEMPLATE_DISABLED
          - CS_FIELD_VALUE_INVALID
          - CS_FIELD_HISTORY_NOT_ALLOWED
          - CS_FIELD_AGGREGATION_IS_MANDATORY
          - CS_FIELD_AGGREGATION_WINDOW_FORBIDDEN
          - CS_FIELD_AGGREGATION_WINDOW_REQUIRED
          - CS_FIELD_AGGREGATION_WINDOW_NOT_VALID
          - CS_FIELD_SOURCE_EVENT_FIELD_NOT_VALID
          - CS_COMPUTED_ENABLED_REQUIRED
          - CS_CUSTOMER_JOURNEY_STATE_NOT_FOUND
          - CS_CUSTOMER_JOURNEY_COULD_NOT_BE_EDITED_AFTER_BE_ENABLED
          - CS_PARAMETER_MISSING_OR_INVALID
          - CS_RESOURCE_NOT_FOUND
          - CS_JOURNEY_NOT_FOUND
          - CS_JOURNEY_ALREADY_ENABLED_OR_TERMINATED
          - CS_JOURNEY_ENABLED
          - CS_JOURNEY_NOT_RUNNING
          - CS_JOURNEY_INVALID
          - CS_JOURNEY_CANT_ADD_CUSTOMERS
          - CS_JOURNEY_STATE_INVALID
          - CS_FORBIDDEN
          - CS_BRANCH_STATS_NOT_FOUND
          - CS_JOURNEY_STATE_STATS_NOT_FOUND
          - CS_STATS_NOT_FOUND
          - CS_BAD_REQUEST
          - CS_INVALID_FILTER
          - CS_INVALID_ORDER
          - CS_CUSTOMER_DATA_CSV_EXPORT_NOT_ENABLED
          - CS_WEBHOOK_TEMPLATE_NOT_FOUND
          - CS_WEBHOOK_TEMPLATE_BODY_NOT_ALLOWED_FOR_GET
          - CS_WEBHOOK_TEMPLATE_URL_INVALID
          - CS_WEBHOOK_TEMPLATE_BODY_INVALID
          - CS_SEGMENT_NOT_FOUND
          - CS_SEGMENT_INVALID
          - CS_SEGMENT_ALREADY_EXISTS
          - CS_AUDIENCE_LIST_NOT_FOUND
          - CS_AUDIENCE_LIST_INVALID
          - CS_AUDIENCE_LIST_ALREADY_EXISTS
          - CS_CDP_EVENT_NOT_FOUND
          - CS_CDP_EVENT_ALREADY_EXISTS
          - CS_CDP_EVENT_TYPE_INVALID
          - CS_CDP_EVENT_TYPE_RETENTION_DAYS_LIMIT_EXCEEDED
          - CS_CDP_EVENT_TYPE_EVENT_HISTORY_NOT_ALLOWED
          - CS_CDP_EVENT_FIELD_LIMIT_REACHED
          - CS_CDP_EVENT_TEMPLATE_NOT_FOUND
          - CS_CDP_EVENTS_INGESTION_NOT_ENABLED
          - CS_CDP_FIELD_AGGREGATED_NOT_ENABLED
          - CS_INVALID_FIELD_ROLE
          - CS_FIELD_ROLE_VALUE_TYPE_MISMATCH
          - CS_MANUAL_COMPUTE_LIMIT_EXCEEDED
          description: '* `CS_CUSTOMER_NOT_ENABLED` - The customer feature is not available for this application

            * `CS_CUSTOMER_NOT_FOUND` - Customer not found

            * `CS_CUSTOMER_ID_IN_USE` - External code is already in use

            * `CS_CUSTOMER_WITH_NO_FIELDS` - This customer id has no custom fields

            * `CS_APPLICATION_WITH_NO_FIELDS` - This application id has no custom fields

            * `CS_CUSTOMER_FIELD_ALREADY_EXISTS` - Customer field already exists

            * `CS_INVALID_CUSTOMER_FIELD_NAME` - Invalid customer field name

            * `CS_CUSTOMER_FIELD_NOT_FOUND` - Customer field name not found

            * `CS_API_GATEWAY_TOKEN_NOT_VALID` - Gateway token is not valid

            * `CS_ERROR_PROCESSING_GATEWAY_TOKEN` - Error processing gateway token

            * `CS_AUTHORIZATION_FORMAT_ERROR` - Authorization is not present or has no right format

            * `CS_NOT_VALID_IP` - IP is not valid

            * `CS_NOT_VALID_KEY` - Key is not valid

            * `CS_SERVER_ERROR` - Server Error

            * `CS_TOO_MANY_REQUEST` - Too many request for your account, try again in ${seconds} seconds

            * `CS_CAMPAING_ID_NOT_FOUND` - Campaign id not found

            * `CS_CSV_FORMAT_NOT_SUPPORTED` - Some error in the csv format

            * `CS_CSV_WITH_NO_CUSTOMERS` - There are no customers in this CSV

            * `CS_CSV_WITH_NO_CUSTOMER_ID_FIELD` - customerId field not found in this CSV

            * `CS_COMPUTED_ENABLED_REQUIRED` - The computedEnabled field is required for computed fields

            * `CS_CSV_WITH_NO_CUSTOMER_FIELDS` - Customer fields not found in headers

            * `CS_INCORRECT_SCHEDULE_AT_DATE` - The date must be greater than the current date

            * `CS_CUSTOMER_JOURNEY_NOT_FOUND` - Customer Journey not found

            * `CS_CUSTOMER_JOURNEY_TEMPLATE_NOT_FOUND` - Customer Journey Template not found

            * `CS_CUSTOMER_JOURNEY_TEMPLATE_DISABLED` - Customer Journey Template is disabled

            * `CS_FIELD_VALUE_INVALID` - The value of a field for a customer has been set to the wrong value or format

            * `CS_FIELD_HISTORY_NOT_ALLOWED` - Field event history not allowed

            * `CS_FIELD_AGGREGATION_IS_MANDATORY` - Field aggregation is mandatory

            * `CS_FIELD_AGGREGATION_WINDOW_FORBIDDEN` - Field aggregation window is forbidden

            * `CS_FIELD_AGGREGATION_WINDOW_REQUIRED` - Field aggregation window is required

            * `CS_FIELD_AGGREGATION_WINDOW_NOT_VALID` - Field aggregation window is not valid format

            * `CS_FIELD_SOURCE_EVENT_FIELD_NOT_VALID` - Field source event field is not valid and required

            * `CS_CUSTOMER_JOURNEY_STATE_NOT_FOUND` - Customer Journey State not found

            * `CS_CUSTOMER_JOURNEY_COULD_NOT_BE_EDITED_AFTER_BE_ENABLED` - Customer Journey could not be edited after be enabled

            * `CS_PARAMETER_MISSING_OR_INVALID` - Some parameter is invalid or missing

            * `CS_RESOURCE_NOT_FOUND` - Resource not found

            * `CS_JOURNEY_NOT_FOUND` - Journey not found

            * `CS_JOURNEY_ALREADY_ENABLED_OR_TERMINATED` - The journey is running or has been running and has already stopped.

            * `CS_JOURNEY_ENABLED` - The journey is running

            * `CS_JOURNEY_NOT_RUNNING` - The journey is not running

            * `CS_JOURNEY_INVALID` - Invalid configuration of journey

            * `CS_JOURNEY_CANT_ADD_CUSTOMERS` - The journey does not allow to add customers

            * `CS_JOURNEY_STATE_INVALID` - Invalid parameters of journey state

            * `CS_FORBIDDEN` - Forbidden

            * `CS_BRANCH_STATS_NOT_FOUND` - Statistics not found

            * `CS_JOURNEY_STATE_STATS_NOT_FOUND` - Statistics not found

            * `CS_STATS_NOT_FOUND` - Statistics not found

            * `CS_BAD_REQUEST` - Bad request

            * `CS_INVALID_FILTER` - Invalid filter

            * `CS_INVALID_ORDER` - Invalid order

            * `CS_CUSTOMER_DATA_CSV_EXPORT_NOT_ENABLED` - Customer data CSV export feature not enabled for this application

            * `CS_WEBHOOK_TEMPLATE_NOT_FOUND` - Webhook template not found

            * `CS_WEBHOOK_TEMPLATE_BODY_NOT_ALLOWED_FOR_GET` - Webhook template body not allowed for GET requests

            * `CS_WEBHOOK_TEMPLATE_URL_INVALID` - Webhook template url is invalid

            * `CS_WEBHOOK_TEMPLATE_BODY_INVALID` - Webhook template body is invalid

            * `CS_SEGMENT_NOT_FOUND` - Segment not found

            * `CS_SEGMENT_INVALID` - Invalid configuration of segment

            * `CS_SEGMENT_ALREADY_EXISTS` - Segment already exists

            * `CS_AUDIENCE_LIST_NOT_FOUND` - Audience list not found

            * `CS_AUDIENCE_LIST_INVALID` - Invalid configuration of audience list

            * `CS_AUDIENCE_LIST_ALREADY_EXISTS` - Audience list already exists

            * `CS_CDP_EVENT_AGGREGATED_NOT_ENABLED` - CDP Event aggregated not enabled

            * `CS_CDP_EVENT_NOT_FOUND` - CDP Event not found

            * `CS_CDP_EVENT_ALREADY_EXISTS` - CDP Event already exists

            * `CS_CDP_EVENT_TYPE_INVALID` - Invalid configuration of CDP Event Type

            * `CS_CDP_EVENT_TYPE_RETENTION_DAYS_LIMIT_EXCEEDED` - CDP Event Type retention days limit exceeded

            * `CS_CDP_EVENT_TYPE_EVENT_HISTORY_NOT_ALLOWED` - CDP Event Type event history not allowed

            * `CS_CDP_EVENT_FIELD_LIMIT_REACHED` - CDP Event Type field limit reached

            * `CS_CDP_EVENT_TEMPLATE_NOT_FOUND` - CDP Event Template not found

            * `CS_CDP_EVENTS_INGESTION_NOT_ENABLED` - CDP Events ingestion not enabled

            * `CS_CDP_FIELD_AGGREGATED_NOT_ENABLED` - CDP Field aggregated not enabled

            * `CS_INVALID_FIELD_ROLE` - Invalid field role value

            * `CS_FIELD_ROLE_VALUE_TYPE_MISMATCH` - Field role requires a different valueType

            * `CS_MANUAL_COMPUTE_LIMIT_EXCEEDED` - Monthly limit of manual compute executions exceeded

            '
        message:
          type: string
          description: Error message
  securitySchemes:
    Authorization:
      type: apiKey
      in: header
      name: Authorization
      description: 'Authorization for accesing endpoints , must be in one of the following format:

        - **Bearer {token}**

        - **ServerKey {key}**

        '
    MultimediaJWT:
      type: apiKey
      in: query
      name: jwt
      description: JWT token for signed URL multimedia authentication (query param)
x-tagGroups:
- name: Chat Service
  tags:
  - chat-configuration
  - chat-channel
  - chat-contact
  - chat-integration
  - chat-task
  - chat-campaign
  - chat-send
  - chat-multimedia
  - chat-slicing
  - chat-tag
  - chat-contact-list
  - chat-cc-agent
  - chat-cc-permissions-profile
  - chat-cc-weekly-schedule
  - chat-cc-special-days-schedule
  - chat-cc-conversation
  - chat-cc-agent-group
  - chat-cc-contact-comment
  - chat-cc-form
  - chat-stats
  - chat-internal
- name: Customer Service
  tags:
  - customer-service-adviser
  - customer-service-customer
  - customer-service-customer-csv
  - customer-service-customer-field
  - customer-service-customer-journey
  - customer-service-customer-journey-template
  - customer-service-customer-journey-control
  - customer-service-customer-send
  - customer-service-stats
  - customer-service-webhook-template
  - customer-service-segment
  - customer-service-audience
  - customer-service-application


# --- truncated at 32 KB (70 KB total) ---
# Full source: https://artifacts.apis.io/indigitall/openapi/indigitall-customer-service-webhook-template-api-openapi.yml