/integrations/maverick/config

POST /integrations/maverick/config

Create Maverick integration

Set up new Maverick integration

Authentication Required

Authorization: Bearer {token} header string

This header is required to access this endpoint

Required Parameters

x-account-id header string

Account ID for the request

{
  "apiUrl": "string",
  "apiKey": "string"
}

{
  "apiUrl": "string",
  "apiKey": "string",
  "enabled": true,
  "autoSync": false,
  "syncIntervalMinutes": 15
}

Try it out

Output:

Responses

Description

Integration created successfully

{
  "id": "string",
  "apiUrl": "string",
  "apiKey": "string",
  "enabled": false,
  "autoSync": false,
  "syncIntervalMinutes": 0,
  "createdAt": "string",
  "updatedAt": "string"
}

References

#/components/parameters/xAccountIdHeader #/components/schemas/MaverickConfigInput #/components/schemas/MaverickConfig

#/components/parameters/xAccountIdHeader

OpenAPI
TypeScript

in: header
name: x-account-id
schema:
  type: string
description: Account ID for the request
required: true
example: "2311"

|
export type xAccountIdHeader = any; // Schema type not fully supported

#/components/schemas/MaverickConfigInput

OpenAPI
TypeScript

type: object
required:
  - apiUrl
  - apiKey
properties:
  apiUrl:
    type: string
  apiKey:
    type: string
  enabled:
    type: boolean
    default: true
  autoSync:
    type: boolean
    default: false
  syncIntervalMinutes:
    type: integer
    default: 15

|
export interface MaverickConfigInput {
  apiUrl: string;
  apiKey: string;
  enabled?: boolean;
  autoSync?: boolean;
  syncIntervalMinutes?: number;
}

#/components/schemas/MaverickConfig

OpenAPI
TypeScript

type: object
properties:
  id:
    type: string
  apiUrl:
    type: string
  apiKey:
    type: string
  enabled:
    type: boolean
  autoSync:
    type: boolean
  syncIntervalMinutes:
    type: integer
  createdAt:
    type: string
    format: date-time
  updatedAt:
    type: string
    format: date-time

|
export interface MaverickConfig {
  id?: string;
  apiUrl?: string;
  apiKey?: string;
  enabled?: boolean;
  autoSync?: boolean;
  syncIntervalMinutes?: number;
  createdAt?: Date;
  updatedAt?: Date;
}

Route Source Code

Check out the source code for this route entrypoint here: /integrations/maverick/config/route.ts

Or the swagger.yaml spec this documentation was generated from: /integrations/maverick/swagger.yaml