Infoworks

Infoworks Job Hooks API

The Job Hooks API from Infoworks — 9 operation(s) for job hooks.

GitHub OpenAPI

Operations 13

GET /admin/job-hooks Get Job Hooks List
POST /admin/job-hooks Create a Job Hook
GET /admin/job-hooks/{job_hook_id} Get Job Hook By Id
PATCH /admin/job-hooks/{job_hook_id} Update Job Hook Type By Id
DELETE /admin/job-hooks/{job_hook_id} Delete Job Hook By Id
GET /admin/job-hooks/{job_hook_id}/files Get all files in Job Hook by id
POST /admin/job-hooks/{job_hook_id}/files add file in Job Hook by id
GET /admin/audit/job-hooks/global Get Global Audit Job Hooks List
GET /admin/audit/job-hooks/{extension_id} Get Audit Job Hooks List
GET /admin/audit/pipeline-extensions/global Get Global Audit Pipeline Extension List
GET /admin/audit/pipeline-extensions/{extension_id} Get Audit Pipeline Extension List
GET /admin/audit/source-extensions/global Get Global Audit Source Extension List
GET /admin/audit/source-extensions/{extension_id} Get Audit Source Extension List

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/infoworks/refs/heads/main/authentication/infoworks-authentication.yml
📖
Documentation
https://docs.infoworks.io/developer-resources/rest-api
📖
APIReference
https://docs.infoworks.io/infoworks-rest-api-v3/ref

Specifications

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

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/infoworks/refs/heads/main/errors/infoworks-problem-types.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/infoworks/refs/heads/main/conventions/infoworks-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/infoworks/refs/heads/main/data-model/infoworks-data-model.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/infoworks-job-hooks-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

infoworks-job-hooks-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact: {}
  title: Infoworks Rest API V3 Job Hooks API
  version: '1.0'
  description: Infoworks Rest API V3
servers:
- url: '{protocol}://{host}:{port}/v3'
  variables:
    protocol:
      default: http
      enum:
      - http
      - https
    host:
      default: localhost
    port:
      default: '3001'
tags:
- name: Job Hooks
  description: ''
paths:
  /admin/job-hooks:
    parameters:
    - name: Content-Type
      in: header
      description: Http content type
      required: true
      schema:
        type: string
        enum:
        - application/json
        - multipart/form-data
        - text/plain
        default: application/json
    get:
      security:
      - BearerAuth: []
      tags:
      - Job Hooks
      parameters:
      - name: offset
        in: query
        description: The number of items to skip before starting to collect the result set
        schema:
          type: integer
          default: 0
      - name: limit
        in: query
        description: The numbers of items to return
        schema:
          type: integer
          default: 10
      - name: sort_by
        in: query
        description: Sort result on field
        schema:
          type: string
      - name: order_by
        in: query
        description: order  ascending | descending
        schema:
          type: string
          default: asc
          enum:
          - asc
          - desc
      - name: filter
        in: query
        description: Filter results query
        schema:
          type: string
      summary: Get Job Hooks List
      description: Get Job Hooks List
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: List of Job Hooks.
                  result:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: 6fb069238f33b86d4262dcdc
                        execution_type:
                          type: string
                          example: PYTHON
                        name:
                          type: string
                          example: test
                        parameters:
                          type: string
                          example: ''
                        fail_job_if_hook_fails:
                          type: boolean
                          example: true
                        executable_file_name:
                          type: string
                          example: test.py
                        file_details:
                          type: array
                          items:
                            type: object
                            properties:
                              file_name:
                                type: string
                                example: terajdbc4.jar
                              file_path:
                                type: string
                                example: /opt/infoworks/lib/ingestion/drivers/test/terajdbc4.jar
                              file_size:
                                type: integer
                                example: 963400
                              uploaded_by:
                                type: string
                                example: 6RkfybTRQQByEey3v
                              last_modified:
                                type: string
                                example: '2019-11-21T12:54:05.875Z'
                        environment_variables_conf:
                          type: array
                          items:
                            type: object
                            required:
                            - name
                            - config_type
                            properties:
                              name:
                                type: string
                                example: RDBMS_PASSWORD
                              config_type:
                                type: string
                                example: KEYVAULT
                                enum:
                                - KEYVAULT
                                - ADMIN
                              config_name:
                                type: string
                                example: iw_admin_conf
                              secret_id:
                                type: string
                                example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10006
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10005
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10004
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10002
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10002
    post:
      security:
      - BearerAuth: []
      tags:
      - Job Hooks
      summary: Create a Job Hook
      description: Create a Job Hook
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              required:
              - name
              - executable_file_name
              - execution_type
              - files
              properties:
                name:
                  type: string
                  example: test
                  pattern: ^[a-z0-9A-Z_-]+$
                execution_type:
                  type: string
                  example: PYTHON
                  enum:
                  - BASH
                  - PYTHON
                executable_file_name:
                  type: string
                  example: test.py
                failJobIfHookFails:
                  type: boolean
                  example: false
                parameters:
                  type: string
                  example: ''
                files:
                  description: Required files if upload_option is fileUpload
                  type: string
                  format: binary
                  example: test.py
                environment_variables_conf:
                  description: Additional environment variables to pass in process
                  type: array
                  items:
                    type: object
                    required:
                    - name
                    - config_type
                    properties:
                      name:
                        type: string
                        example: RDBMS_PASSWORD
                      config_type:
                        type: string
                        example: KEYVAULT
                        enum:
                        - KEYVAULT
                        - ADMIN
                      config_name:
                        type: string
                        example: iw_admin_conf
                      secret_id:
                        type: string
                        example: e77850ad5127a2d7dab870ff
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Successfully created job hook.
                  result:
                    type: object
                    properties:
                      id:
                        type: string
                        example: 5f9708117758f33f8b013824
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10006
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10005
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10004
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10002
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10002
  /admin/job-hooks/{job_hook_id}:
    parameters:
    - name: Content-Type
      in: header
      description: Http content type
      required: true
      schema:
        type: string
        enum:
        - application/json
        - multipart/form-data
        - text/plain
        default: application/json
    - name: job_hook_id
      in: path
      required: true
      schema:
        type: string
    get:
      security:
      - BearerAuth: []
      tags:
      - Job Hooks
      summary: Get Job Hook By Id
      description: Get Job Hook By Id
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Found Generic Source Type.
                  result:
                    type: object
                    properties:
                      id:
                        type: string
                        example: 6fb069238f33b86d4262dcdc
                      execution_type:
                        type: string
                        example: PYTHON
                      name:
                        type: string
                        example: test
                      parameters:
                        type: string
                        example: ''
                      fail_job_if_hook_fails:
                        type: boolean
                        example: true
                      executable_file_name:
                        type: string
                        example: test.py
                      file_details:
                        type: array
                        items:
                          type: object
                          properties:
                            file_name:
                              type: string
                              example: terajdbc4.jar
                            file_path:
                              type: string
                              example: /opt/infoworks/lib/ingestion/drivers/test/terajdbc4.jar
                            file_size:
                              type: integer
                              example: 963400
                            uploaded_by:
                              type: string
                              example: 6RkfybTRQQByEey3v
                            last_modified:
                              type: string
                              example: '2019-11-21T12:54:05.875Z'
                      environment_variables_conf:
                        type: array
                        items:
                          type: object
                          required:
                          - name
                          - config_type
                          properties:
                            name:
                              type: string
                              example: RDBMS_PASSWORD
                            config_type:
                              type: string
                              example: KEYVAULT
                              enum:
                              - KEYVAULT
                              - ADMIN
                            config_name:
                              type: string
                              example: iw_admin_conf
                            secret_id:
                              type: string
                              example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10006
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10005
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10004
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10002
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10002
    patch:
      security:
      - BearerAuth: []
      tags:
      - Job Hooks
      summary: Update Job Hook Type By Id
      description: Update Job Hook Type By Id
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                name:
                  type: string
                  example: test
                  pattern: ^[a-z0-9A-Z_-]+$
                execution_type:
                  type: string
                  example: PYTHON
                  enum:
                  - BASH
                  - PYTHON
                executable_file_name:
                  type: string
                  example: test.py
                failJobIfHookFails:
                  type: boolean
                  example: false
                parameters:
                  type: string
                  example: ''
                files:
                  description: Required files if upload_option is fileUpload
                  type: string
                  format: binary
                  example: test.py
                environment_variables_conf:
                  description: Additional environment variables to pass in process
                  type: array
                  items:
                    type: object
                    required:
                    - name
                    - config_type
                    properties:
                      name:
                        type: string
                        example: RDBMS_PASSWORD
                      config_type:
                        type: string
                        example: KEYVAULT
                        enum:
                        - KEYVAULT
                        - ADMIN
                      config_name:
                        type: string
                        example: iw_admin_conf
                      secret_id:
                        type: string
                        example: e77850ad5127a2d7dab870ff
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Updates Job Hook
                  result:
                    type: object
                    properties:
                      id:
                        type: string
                        example: 5f9708117758f33f8b013824
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10006
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10005
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10004
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10002
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10002
    delete:
      security:
      - BearerAuth: []
      tags:
      - Job Hooks
      summary: Delete Job Hook By Id
      description: Delete Job Hook By Id
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Deleted Job Hook
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10006
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10005
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10004
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10002
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10002
  /admin/job-hooks/{job_hook_id}/files:
    parameters:
    - name: Content-Type
      in: header
      description: Http content type
      required: true
      schema:
        type: string
        enum:
        - application/json
        - multipart/form-data
        - text/plain
        default: application/json
    - name: job_hook_id
      in: path
      required: true
      schema:
        type: string
    get:
      security:
      - BearerAuth: []
      tags:
      - Job Hooks
      summary: Get all files in Job Hook by id
      description: Get all files in Job Hook by `job_hook_id`
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Example Success Message
                - type: object
                  properties:
                    result:
                      type: array
                      items:
                        type: object
                        properties:
                          file_name:
                            type: string
                            example: terajdbc4.jar
                          file_path:
                            type: string
                            example: /opt/infoworks/lib/ingestion/drivers/test/terajdbc4.jar
                          file_size:
                            type: integer
                            example: 963400
                          uploaded_by:
                            type: string
                            example: 6RkfybTRQQByEey3v
                          last_modified:
                            type: string
                            example: '2019-11-21T12:54:05.875Z'
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10006
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10005
                    help:
                      type: string
                      example

# --- truncated at 32 KB (116 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/infoworks/refs/heads/main/openapi/infoworks-job-hooks-api-openapi.yml