Conga

Conga Hooks Rules API

The Conga Hooks Rules API from Conga — 4 operation(s) for conga hooks rules.

GitHub OpenAPI

Operations 8

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/extensibility/v1/servicehooks/rules List service hook rules · Retrieve all service hooks rules #
Ask an LLM
“Which service hook rules are set up in my Conga platform?”
“Can I filter service hook rules by criteria and sort them?”
Tell an agent
List all service hook rules.
Find service hook rules matching {criteria}, page {pageNumber} with {pageSize} per page.
POST /api/extensibility/v1/servicehooks/rules Create a service hook rule · Create a new service hooks rule #
Ask an LLM
“How do I run custom code automatically when a record changes?”
“Can I create a scheduled rule instead of a data-change rule?”
Tell an agent
Create a service hook rule {Name} on object {ObjectName} that fires on {EventTypes}.
Add a new {RuleType} service hook rule named {Name} with schedule {ScheduleDetails}.
GET /api/extensibility/v1/servicehooks/rules/cancellation/settings Get the service hook cancellation timeout setting · Get service hooks cancellation token setting configuration #
Ask an LLM
“What abort timeout is configured for service hook executions?”
“Is a cancellation token setting configured for service hooks yet?”
Tell an agent
Show the current service hook cancellation token settings.
Tell me the execution abort timeout for service hooks.
PUT /api/extensibility/v1/servicehooks/rules/cancellation/settings Set the service hook cancellation timeout · Upsert service hooks cancellation token setting configuration #
Ask an LLM
“How do I change how long a service hook can run before it is aborted?”
“Can I create the cancellation setting if none exists yet?”
Tell an agent
Set the service hook execution abort timeout to {ExecutionAbortTimeout}.
Create or update the cancellation token setting with timeout {ExecutionAbortTimeout}.
GET /api/extensibility/v1/servicehooks/rules/supported-event-types List supported service hook event types · Retrieve all supported event types in service hook rules #
Ask an LLM
“Which events can a service hook rule be triggered by?”
“What event types are supported when defining hook rules?”
Tell an agent
List every event type supported by service hook rules.
Show me the events I can attach a hook rule to.
DELETE /api/extensibility/v1/servicehooks/rules/{name} Delete a service hook rule · Delete a service hooks rule #
Ask an LLM
“How do I remove a service hook rule I no longer want?”
“Can I delete a hook rule by its name?”
Tell an agent destructive · confirm first
Delete the service hook rule {name}.
Remove hook rule {name} permanently.
GET /api/extensibility/v1/servicehooks/rules/{name} Get a service hook rule by name · Retrieve a service hooks rule by name #
Ask an LLM
“What condition and events does a particular service hook rule use?”
“Can I look up a single hook rule using its name?”
Tell an agent
Fetch the service hook rule named {name}.
Show the configuration of hook rule {name}.
PATCH /api/extensibility/v1/servicehooks/rules/{name} Update a service hook rule · Update a service hooks rule #
Ask an LLM
“Can I deactivate a service hook rule without deleting it?”
“Is it possible to change the condition or events on an existing hook rule?”
Tell an agent
Set hook rule {name} active flag to {IsActive}.
Change the condition on service hook rule {name} to {Condition}.

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/authentication/conga-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/rate-limits/conga-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/openapi/conga-conga-hooks-rules-api-openapi.yml

Other Resources

🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/data-model/conga-data-model.yml
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/scopes/conga-scopes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/conventions/conga-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/errors/conga-problem-types.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/lifecycle/conga-lifecycle.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/conformance/conga-conformance.yml
🔗
Sandbox
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/sandbox/conga-sandbox.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/asyncapi/conga-webhooks.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/conga:conga-conga-hooks-rules-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

conga-conga-hooks-rules-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Extensibility Conga Hooks Rules API
  version: v1
servers:
- url: https://rls.congacloud.com
- url: https://preview-rls09.congacloud.com
security:
- bearerAuth: []
tags:
- name: Conga Hooks Rules
paths:
  /api/extensibility/v1/servicehooks/rules:
    get:
      tags:
      - Conga Hooks Rules
      summary: Retrieve all service hooks rules
      description: Returns service hooks rules that meet the parameter conditions.
      parameters:
      - name: criteria
        in: query
        description: 'Search criteria for the rule <p>**For Example**: `Name=''SampleRule''`.</p>'
        schema:
          type: string
      - name: pageSize
        in: query
        description: The number of records to display on each page
        schema:
          type: integer
          format: int32
      - name: pageNumber
        in: query
        description: The page number of the result set to view
        schema:
          type: integer
          format: int32
      - name: sortField
        in: query
        description: Field name for sorting
        schema:
          type: string
      - name: sortDirection
        in: query
        description: Sort direction of the result set <p>(ASC or DESC)</p>
        schema:
          $ref: '#/components/schemas/SortDirection'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ServiceHooksRuleGetResponse'
              example:
                Success: true
                Data:
                - Name: Name
                  EventTypes:
                  - Update
                  ObjectName: Name_Of_Object
                  IsActive: true
                  Condition: Condition_On_Which_Rule_Will_Get_executed
                  CustomCodeDetails:
                    Id: Project_Id
                    Parameters: null
                    MethodName: null
                    ClassName: Name_Of_Class
                    ProjectName: Name_Of_Project
                  ScheduleDetails: null
                  RuleType: DataChange
                  ModifiedOn: '0001-01-01T00:00:00'
                - Name: Name
                  EventTypes:
                  - Update
                  ObjectName: Name_Of_Object
                  IsActive: true
                  Condition: null
                  CustomCodeDetails:
                    Id: Project_Id
                    Parameters:
                    - Parameters
                    MethodName: Name_Of_Method
                    ClassName: Name_Of_Class
                    ProjectName: Name_Of_Project
                  ScheduleDetails:
                    JobType: Cron
                    Frequency: Daily
                    ExecutionTimeUtc: '2026-08-14T00:04:15.9019949Z'
                  RuleType: Schedule
                  ModifiedOn: '0001-01-01T00:00:00'
                StatusCode: OK
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorResponseExampleAPIResponse'
              example:
                Success: false
                Data: null
                Errors:
                - Message: Bad Request Error Message
                StatusCode: BadRequest
                NextCursor: null
        '500':
          description: Internal Server Error
      operationId: getApiExtensibilityV1ServicehooksRules
      x-operation-id-source: derived
    post:
      tags:
      - Conga Hooks Rules
      summary: Create a new service hooks rule
      description: Validates and creates the data change or schedule rule and returns the rule information.
      requestBody:
        description: Service hooks rule details to be added.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceHooksRuleCreateRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ServiceHooksRuleCreateRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ServiceHooksRuleCreateRequest'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceHooksRuleCreateResponse'
              example:
                Success: true
                Data:
                  Name: Name
                  EventTypes:
                  - Update
                  ObjectName: Name_Of_Object
                  IsActive: true
                  Condition: Condition_Expression
                  CustomCodeDetails:
                    Id: null
                    Parameters: null
                    MethodName: null
                    ClassName: Name_Of_Class
                    ProjectName: Name_Of_Project
                  ScheduleDetails: null
                  RuleType: DataChange
                  ModifiedOn: '0001-01-01T00:00:00'
                StatusCode: OK
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorResponseExampleAPIResponse'
              example:
                Success: false
                Data: null
                Errors:
                - Message: Bad Request Error Message
                StatusCode: BadRequest
                NextCursor: null
        '500':
          description: Internal Server Error
      operationId: postApiExtensibilityV1ServicehooksRules
      x-operation-id-source: derived
  /api/extensibility/v1/servicehooks/rules/cancellation/settings:
    get:
      tags:
      - Conga Hooks Rules
      summary: Get service hooks cancellation token setting configuration
      description: Fetches service hooks cancellation token setting configuration details.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallbackCustomCodeSettingsResponseAPIResponse'
              example:
                Success: true
                Data:
                  ExecutionAbortTimeout: 1000
                StatusCode: OK
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorResponseExampleAPIResponse'
              example:
                Success: false
                Data: null
                Errors:
                - Message: Bad Request Error Message
                StatusCode: BadRequest
                NextCursor: null
        '401':
          description: Unauthorized
        '500':
          description: Internal Server Error
      operationId: getApiExtensibilityV1ServicehooksRulesCancellationSettings
      x-operation-id-source: derived
    put:
      tags:
      - Conga Hooks Rules
      summary: Upsert service hooks cancellation token setting configuration
      description: If a cancellation token setting is already configured, it is updated; otherwise, a new one is created.
      requestBody:
        description: CustomCodeGuardrail configuration data to be updated
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomCodeSettingsRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/CustomCodeSettingsRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/CustomCodeSettingsRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BooleanNullableAPIResponse'
              example:
                Success: true
                Data: true
                StatusCode: OK
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorResponseExampleAPIResponse'
              example:
                Success: false
                Data: null
                Errors:
                - Message: Bad Request Error Message
                StatusCode: BadRequest
                NextCursor: null
        '500':
          description: Internal Server Error
      operationId: putApiExtensibilityV1ServicehooksRulesCancellationSettings
      x-operation-id-source: derived
  /api/extensibility/v1/servicehooks/rules/supported-event-types:
    get:
      tags:
      - Conga Hooks Rules
      summary: Retrieve all supported event types in service hook rules
      description: Fetches all supported event types.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringListAPIResponse'
              example:
                Success: true
                Data:
                - GET
                - POST
                - PUT
                - DELETE
                StatusCode: OK
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: true
                Data: newsampleApi deleted successfully.
                StatusCode: OK
        '500':
          description: Internal Server Error
      operationId: getApiExtensibilityV1ServicehooksRulesSupportedEventTypes
      x-operation-id-source: derived
  /api/extensibility/v1/servicehooks/rules/{name}:
    delete:
      tags:
      - Conga Hooks Rules
      summary: Delete a service hooks rule
      description: Validates and removes the given service hooks rule.
      parameters:
      - name: name
        in: path
        description: Service hooks rule name
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: true
                Data: 4ef10131-33cd-48fd-a9bb-9f163be96193 deleted successfully.
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorResponseExampleAPIResponse'
              example:
                Success: false
                Data: null
                Errors:
                - Message: Bad Request Error Message
                StatusCode: BadRequest
                NextCursor: null
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
      operationId: deleteApiExtensibilityV1ServicehooksRulesByName
      x-operation-id-source: derived
    get:
      tags:
      - Conga Hooks Rules
      summary: Retrieve a service hooks rule by name
      description: Retrieves the service hooks rule details for the given name.
      parameters:
      - name: name
        in: path
        description: Service hooks rule name to get the rule details
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceHooksRuleGetResponse'
              example:
                Success: true
                Data:
                  Name: Name
                  EventTypes: []
                  ObjectName: Name_Of_Object
                  IsActive: true
                  Condition: Condition_On_Which_Rule_Will_Get_executed
                  CustomCodeDetails:
                    Id: Project_Id
                    Parameters: null
                    MethodName: null
                    ClassName: Class_Name
                    ProjectName: Project_Name
                  ScheduleDetails: null
                  RuleType: DataChange
                  ModifiedOn: '0001-01-01T00:00:00'
                StatusCode: OK
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorResponseExampleAPIResponse'
              example:
                Success: false
                Data: null
                Errors:
                - Message: Bad Request Error Message
                StatusCode: BadRequest
                NextCursor: null
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
      operationId: getApiExtensibilityV1ServicehooksRulesByName
      x-operation-id-source: derived
    patch:
      tags:
      - Conga Hooks Rules
      summary: Update a service hooks rule
      description: Validates and updates the service hooks rule and returns the updated rule information.
      parameters:
      - name: name
        in: path
        description: Service hooks rule name
        required: true
        schema:
          type: string
      requestBody:
        description: Service hooks rule details to be updated.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceHooksRuleUpdateRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ServiceHooksRuleUpdateRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ServiceHooksRuleUpdateRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceHooksRuleUpdateResponse'
              example:
                Success: true
                Data:
                  Name: Name
                  EventTypes:
                  - Update
                  ObjectName: Name_Of_Object
                  IsActive: true
                  Condition: Condition_Expression
                  CustomCodeDetails:
                    Id: null
                    Parameters: null
                    MethodName: null
                    ClassName: Name_Of_Class
                    ProjectName: Name_Of_Project
                  ScheduleDetails: null
                  RuleType: DataChange
                  ModifiedOn: '0001-01-01T00:00:00'
                StatusCode: OK
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorResponseExampleAPIResponse'
              example:
                Success: false
                Data: null
                Errors:
                - Message: Bad Request Error Message
                StatusCode: BadRequest
                NextCursor: null
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
      operationId: patchApiExtensibilityV1ServicehooksRulesByName
      x-operation-id-source: derived
components:
  schemas:
    SchedulerFrequency:
      enum:
      - Daily
      - Weekly
      - Monthly
      - Yearly
      - Hourly
      type: string
    CallbackCustomCodeSettingsResponse:
      type: object
      properties:
        ExecutionAbortTimeout:
          type: integer
          format: int32
      additionalProperties: false
    BadRequestErrorResponseExampleAPIResponse:
      type: object
      properties:
        Success:
          type: boolean
        RecordCount:
          type:
          - integer
          - 'null'
          format: int64
        Data:
          $ref: '#/components/schemas/BadRequestErrorResponseExample'
        Errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ErrorDetail'
        Profile:
          type:
          - string
          - 'null'
        TotalTime:
          type: number
          format: float
        StatusCode:
          $ref: '#/components/schemas/HttpStatusCode'
        HasMoreRecords:
          type:
          - boolean
          - 'null'
        NextCursor:
          type:
          - string
          - 'null'
        Warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ErrorDetail'
      additionalProperties: false
    ScheduleDetailModel:
      type: object
      properties:
        JobType:
          $ref: '#/components/schemas/ScheduledJobType'
        Frequency:
          $ref: '#/components/schemas/Frequency'
        ExecutionTimeUtc:
          type:
          - string
          - 'null'
          format: date-time
      additionalProperties: false
    ScheduledJobType:
      enum:
      - Cron
      - OneTime
      type: string
    ServiceHooksRuleUpdateResponse:
      type: object
      properties:
        Name:
          type:
          - string
          - 'null'
          description: Data change custom code rule name
        EventTypes:
          type:
          - array
          - 'null'
          items:
            type: string
          description: "List of action types for which rule should be evaluated. \nSupported Action Types: Create, Update, and Delete."
        ObjectName:
          type:
          - string
          - 'null'
          description: Object name for which rule should be evaluated.
        IsActive:
          type: boolean
          description: Indicates whether the rule is active.
        Condition:
          type:
          - string
          - 'null'
          description: The rule expression or condition that will be evaluated.
        CustomCodeDetails:
          $ref: '#/components/schemas/CustomCodeDetail'
        ScheduleDetails:
          $ref: '#/components/schemas/ScheduleDetailModel'
        RuleType:
          $ref: '#/components/schemas/ServiceHooksRuleType'
        ModifiedOn:
          type: string
          format: date-time
      additionalProperties: false
    CustomCodeDetail:
      type: object
      properties:
        Id:
          type:
          - string
          - 'null'
        Parameters:
          type:
          - array
          - 'null'
          items: {}
        MethodName:
          type:
          - string
          - 'null'
        ClassName:
          type:
          - string
          - 'null'
        ProjectName:
          type:
          - string
          - 'null'
      additionalProperties: false
    StringListAPIResponse:
      type: object
      properties:
        Success:
          type: boolean
        RecordCount:
          type:
          - integer
          - 'null'
          format: int64
        Data:
          type:
          - array
          - 'null'
          items:
            type: string
        Errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ErrorDetail'
        Profile:
          type:
          - string
          - 'null'
        TotalTime:
          type: number
          format: float
        StatusCode:
          $ref: '#/components/schemas/HttpStatusCode'
        HasMoreRecords:
          type:
          - boolean
          - 'null'
        NextCursor:
          type:
          - string
          - 'null'
        Warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ErrorDetail'
      additionalProperties: false
    CallbackCustomCodeSettingsResponseAPIResponse:
      type: object
      properties:
        Success:
          type: boolean
        RecordCount:
          type:
          - integer
          - 'null'
          format: int64
        Data:
          $ref: '#/components/schemas/CallbackCustomCodeSettingsResponse'
        Errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ErrorDetail'
        Profile:
          type:
          - string
          - 'null'
        TotalTime:
          type: number
          format: float
        StatusCode:
          $ref: '#/components/schemas/HttpStatusCode'
        HasMoreRecords:
          type:
          - boolean
          - 'null'
        NextCursor:
          type:
          - string
          - 'null'
        Warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ErrorDetail'
      additionalProperties: false
    ServiceHooksRuleCreateRequest:
      type: object
      properties:
        Name:
          type:
          - string
          - 'null'
          description: Data change custom code rule name
        EventTypes:
          type:
          - array
          - 'null'
          items:
            type: string
          description: "List of action types for which rule should be evaluated. \nSupported Action Types: Create, Update, and Delete."
        ObjectName:
          type:
          - string
          - 'null'
          description: Object name for which rule should be evaluated.
        IsActive:
          type: boolean
          description: Indicates whether the rule is active.
        Condition:
          type:
          - string
          - 'null'
          description: The rule expression or condition that will be evaluated.
        CustomCodeDetails:
          $ref: '#/components/schemas/CustomCodeDetail'
        ScheduleDetails:
          $ref: '#/components/schemas/ScheduleDetail'
        RuleType:
          $ref: '#/components/schemas/ServiceHooksRuleType'
      additionalProperties: false
    BooleanNullableAPIResponse:
      type: object
      properties:
        Success:
          type: boolean
        RecordCount:
          type:
          - integer
          - 'null'
          format: int64
        Data:
          type:
          - boolean
          - 'null'
        Errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ErrorDetail'
        Profile:
          type:
          - string
          - 'null'
        TotalTime:
          type: number
          format: float
        StatusCode:
          $ref: '#/components/schemas/HttpStatusCode'
        HasMoreRecords:
          type:
          - boolean
          - 'null'
        NextCursor:
          type:
          - string
          - 'null'
        Warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ErrorDetail'
      additionalProperties: false
    CustomCodeSettingsRequest:
      type: object
      properties:
        ExecutionAbortTimeout:
          type: integer
          description: Time interval, in milliseconds, to abort the custom code's execution
          format: int32
      additionalProperties: false
      description: Request model for custom code settings
    ScheduleDetail:
      type: object
      properties:
        JobType:
          $ref: '#/components/schemas/ScheduledJobType'
        Frequency:
          $ref: '#/components/schemas/SchedulerFrequency'
        ExecutionTimeUtc:
          type:
          - string
          - 'null'
          format: date-time
      additionalProperties: false
    HttpStatusCode:
      enum:
      - Continue
      - SwitchingProtocols
      - Processing
      - EarlyHints
      - OK
      - Created
      - Accepted
      - NonAuthoritativeInformation
      - NoContent
      - ResetContent
      - PartialContent
      - MultiStatus
      - AlreadyReported
      - IMUsed
      - MultipleChoices
      - MovedPermanently
      - Found
      - SeeOther
      - NotModified
      - UseProxy
      - Unused
      - TemporaryRedirect
      - PermanentRedirect
      - BadRequest
      - Unauthorized
      - PaymentRequired
      - Forbidden
      - NotFound
      - MethodNotAllowed
      - NotAcceptable
      - ProxyAuthenticationRequired
      - RequestTimeout
      - Conflict
      - Gone
      - LengthRequired
      - PreconditionFailed
      - RequestEntityTooLarge
      - RequestUriTooLong
      - UnsupportedMediaType
      - RequestedRangeNotSatisfiable
      - ExpectationFailed
      - MisdirectedRequest
      - UnprocessableEntity
      - Locked
      - FailedDependency
      - UpgradeRequired
      - PreconditionRequired
      - TooManyRequests
      - RequestHeaderFieldsTooLarge
      - UnavailableForLegalReasons
      - InternalServerError
      - NotImplemented
      - BadGateway
      - ServiceUnavailable
      - GatewayTimeout
      - HttpVersionNotSupported
      - VariantAlsoNegotiates
      - InsufficientStorage
      - LoopDetected
      - NotExtended
      - NetworkAuthenticationRequired
      type: string
    StringAPIResponse:
      type: object
      properties:
        Success:
          type: boolean
        RecordCount:
          type:
          - integer
          - 'null'
          format: int64
        Data:
          type:
          - string
          - 'null'
        Errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ErrorDetail'
        Profile:
          type:
          - string
          - 'null'
        TotalTime:
          type: number
          format: float
        StatusCode:
          $ref: '#/components/schemas/HttpStatusCode'
        HasMoreRecords:
          type:
          - boolean
          - 'null'
        NextCursor:
          type:
          - string
          - 'null'
        Warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ErrorDetail'
      additionalProperties: false
    ServiceHooksRuleType:
      enum:
      - DataChange
      - Schedule
      type: string
    Frequency:
      enum:
      - Daily
      - Weekly
      - Monthly
      - Yearly
      - EveryMinute
      - Hourly
      type: string
    BadRequestErrorResponseExample:
      type: object
      additionalProperties: false
    SortDirection:
      enum:
      - Ascending
      - Descending
      type: string
    ServiceHooksRuleGetResponse:
      type: object
      properties:
        Name:
          type:
          - string
          - 'null'
          description: Data change custom code rule name
        EventTypes:
          type:
          - array
          - 'null'
          items:
            type: string
          description: "List of action types for which rule should be evaluated. \nSupported Action Types: Create, Update, and Delete."
        ObjectName:
          type:
          - string
          - 'null'
          description: Object name for which rule should be evaluated.
        IsActive:
          type: boolean
          description: Indicates whether the rule is active.
        Condition:
          type:
          - string
          - 'null'
          description: The rule expression or condition that will be evaluated.
        CustomCodeDetails:
          $ref: '#/components/schemas/CustomCodeDetail'
        ScheduleDetails:
          $ref: '#/components/schemas/ScheduleDetailModel'
        RuleType:
          $ref: '#/components/schemas/ServiceHooksRuleType'
        ModifiedOn:
          type: string
          format: date-time
      additionalProperties: false
    ServiceHooksRuleUpdateRequest:
      type: object
      properties:
        IsActive:
          type:
          - boolean
          - 'null'
        EventTypes:
          type:
          - array
          - 'null'
          items:
            type: string
        ObjectName:
          type:
          - string
          - 'null'
        Condition:
          type:
          - string
          - 'null'
        CustomCodeDetails:
          $ref: '#/components/schemas/CustomCodeDetail'
        ScheduleDetails:
          $ref: '#/components/schemas/ScheduleDetail'
      additionalProperties: false
    ErrorDetail:
      type: object
      properties:
        Message:
          type:
          - string
          - 'null'
      additionalProperties: false
    ServiceHooksRuleCreateResponse:
      type: object
      properties:
        Name:
          type:
          - string
          - 'null'
          description: Data change custom code rule name
        EventTypes:
          type:
          - array
          - 'null'
          items:
            type: string
          description: "List of action types for which rule should be evaluated. \nSupported Action Types: Create, Update, and Delete."
        ObjectName:
          type:
          - string
          - 'null'
          description: Object name for which rule should be evaluated.
        IsActive:
          type: boolean
          description: Indicates whether the rule is active.
        Condition:
          type:
          - string
          - 'null'
          description: The rule expression or condition that will be evaluated.
        CustomCodeDetails:
          $ref: '#/components/schemas/CustomCodeDetail'
        ScheduleDetails:
          $ref: '#/components/schemas/ScheduleDetailModel'
        RuleType:
          $ref: '#/components/schemas/ServiceHooksRuleType'
        ModifiedOn:
          type: string
          format: date-time
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT