Forsta

Forsta Augeo Callback API

Endpoints related to augeo callback

Documentation GitHub OpenAPI

Operations 4

POST /api/webhook/augeo/oauth2/token Augeo Api Authentication #

GET /api/webhook/augeo/user Augeo Panelist User Query #

POST /api/webhook/augeo/redeem Augeo Panelist Points Redeem #

DELETE /api/webhook/augeo/redeem/{id} Augeo Panelist Points Refund #

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/forsta-augeo-callback-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

openapi: 3.2.0
info:
  title: Data sent by webhooks Augeo Callback API
  version: 1.0.0
  license:
    name: Forsta
    identifier: Forsta
    url: http://forsta.com
  description: Data sent by webhooks
servers:
- url: CLIENT SERVER URL
  description: Panel Management servers
security:
- JWT: []
tags:
- name: Augeo Callback
  description: Endpoints related to augeo callback
paths:
  /api/webhook/augeo/oauth2/token:
    post:
      operationId: vendorCallbackAugeoAuthentication
      summary: Augeo Api Authentication
      tags:
      - Augeo Callback
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                client_id:
                  type: string
                  description: Client id to be authorized
                client_secret:
                  type: string
                  description: Client secret
                grant_type:
                  type: string
                  description: Token grant type
              example:
                client_id: 16af28ee-f541-44da-b94c-40c52848440d
                client_secret: 160ad9c9b2fe2247b1bfc548959cb775e19478dda268f4c86d978fe286282a93e524f73da679990b083d625eb5e9312d8016dd6977aaef40786ca13d0ea7036e
                grant_type: client_credentials
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  access_token:
                    type: string
                    description: Valid token to be used in subsequent calls
                  token_type:
                    type: string
                    description: Authorized grant type
                  expires_in:
                    type: integer
                    description: Token expiration time in seconds
        '401':
          description: Unauthorized
  /api/webhook/augeo/user:
    get:
      operationId: vendorCallbackAugeoUser
      security:
      - JWT: []
      summary: Augeo Panelist User Query
      tags:
      - Augeo Callback
      parameters:
      - name: user_id
        description: User identifier
        in: query
        required: true
        schema:
          type: string
        example: 1-1-PANELIST_ONE
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  user_id:
                    type: string
                    description: User identifier
                  points_balance:
                    type: integer
                    description: Current panelist points balance at the time of the request.
                  demographics:
                    type: object
                    properties:
                      email:
                        type: string
                        description: panelist email
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
  /api/webhook/augeo/redeem:
    post:
      operationId: vendorCallbackAugeoRedeem
      security:
      - JWT: []
      summary: Augeo Panelist Points Redeem
      tags:
      - Augeo Callback
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                user_id:
                  type: string
                  description: User identifier
                points_used:
                  type: integer
                  description: Amount of points to be used  needs to be bigger or smaller than zero
                transaction_id:
                  type: string
                  description: Transaction id reference
              example:
                user_id: 1-1-PANELIST_ONE
                points_used: 10
                transaction_id: '1234567'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: Transaction status
                  remaining_balance:
                    type: integer
                    description: Amount of points remaining
                  id:
                    type: string
                    description: Internal redemption transaction ID. This value is needed when issuing refunds
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: Transaction status
                  message:
                    type: string
                    description: error message
        '401':
          description: Unauthorized
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: Transaction status
                  message:
                    type: string
                    description: error message
        '404':
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: Transaction status
                  message:
                    type: string
                    description: error message
  /api/webhook/augeo/redeem/{id}:
    delete:
      operationId: vendorCallbackAugeoRefund
      security:
      - JWT: []
      summary: Augeo Panelist Points Refund
      tags:
      - Augeo Callback
      parameters:
      - name: id
        description: id provided on the points redemption return payload
        in: path
        required: true
        schema:
          type: string
        example: 1-1-PANELIST_ONE-1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: Transaction status
                  remaining_balance:
                    type: integer
                    description: Amount of points remaining
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: Transaction status
                  message:
                    type: string
                    description: error message
        '401':
          description: Unauthorized
        '404':
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: Transaction status
                  message:
                    type: string
                    description: error message
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: Transaction status
                  message:
                    type: string
                    description: error message
components:
  securitySchemes:
    JWT:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Needs to add an API KEY authentication procedure

        '
x-tagGroups:
- name: Data input and output
  tags:
  - Augeo Callback
  - Vendor Callback