Podium

Podium Webhook API

The Webhook API from Podium — 2 operation(s) for webhook.

GitHub OpenAPI

Operations 5

GET /v4/webhooks List webhooks. #
POST /v4/webhooks Create a webhook. #
DELETE /v4/webhooks/{uid} Delete a webhook. #
GET /v4/webhooks/{uid} Get a webhook. #
PUT /v4/webhooks/{uid} Update a webhook. #

Documentation

📖
Documentation
https://docs.podium.com/reference/introduction
📖
GettingStarted
https://docs.podium.com/docs/getting-started
📖
Authentication
https://docs.podium.com/reference/authentication
📖
APIReference
https://docs.podium.com/reference/introduction

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/podium/refs/heads/main/openapi/podium-webhook-api-openapi.yml

Other Resources

🔗
Versioning
https://docs.podium.com/docs/api-version
🔗
ErrorCodes
https://docs.podium.com/docs/errors
🔗
Webhooks
https://docs.podium.com/reference/webhookget-1
🔗
PostmanWorkspace
https://www.postman.com/podiumhq/podium-s-api-workspace
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/podium/refs/heads/main/scopes/podium-scopes.yml
🔗
Pagination
https://docs.podium.com/reference/pagination

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/podium-webhook-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

podium-webhook-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Webhooks Webhook API
  version: 2021.04.01
servers:
- url: https://api.podium.com
  variables: {}
security: []
tags:
- name: Webhook
paths:
  /v4/webhooks:
    get:
      callbacks: {}
      description: 'List webhooks that are tied to user who has authorized the application.


        Required scope: none.

        '
      operationId: webhook.index
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/webhook'
                    type: array
                  metadata:
                    description: Additional response data.
                    properties:
                      url:
                        description: The resource URL.
                        example: https://www.podium.com/
                        type: string
                    type: object
                type: object
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                properties:
                  code:
                    description: Podium code for the error.
                    type: integer
                  message:
                    description: Specific details about the error.
                    type:
                    - string
                    - 'null'
                  moreInfo:
                    description: URL providing more information about the error.
                    type: string
                title: Error
                type: object
          description: Error response.
      summary: List webhooks.
      tags:
      - Webhook
    post:
      callbacks: {}
      description: 'Create a new webhook to receive events from a location or an organization. One of `locationUid` or

        `organizationUid` is required. If both are given the `organizationUid` will be used.


        Required scope: The required scope(s) will depend on the event type(s) you are subscribing too. See the WEBHOOK EVENT TYPES section.

        '
      operationId: webhook.create
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              properties:
                eventTypes:
                  items:
                    description: Event types that will be sent to webhook.
                    enum:
                    - call.completed
                    - call.missed
                    - call.received
                    - call.voicemail_left
                    - contact.created
                    - contact.deleted
                    - contact.merged
                    - contact.unchanged
                    - contact.updated
                    - invoice.created
                    - invoice.disabled
                    - invoice.marked_as_paid
                    - invoice.payment_created
                    - invoice.payment_failed
                    - invoice.payment_succeeded
                    - invoice.refund_created
                    - invoice.refund_failed
                    - message.failed
                    - message.received
                    - message.sent
                    - review.created
                    - review.invite_link_created
                    - review.invite_link_updated
                    - review.response_created
                    - review.response_updated
                    - review.updated
                    type: string
                  minItems: 1
                  type: array
                locationUid:
                  description: Podium unique identifier for location.
                  example: 00000000-0000-0000-0000-000000000000
                  format: uuid
                  type: string
                organizationUid:
                  description: Podium unique identifier for organization.
                  example: 00000000-0000-0000-0000-000000000000
                  format: uuid
                  type: string
                secret:
                  description: Secret used to sign webhook events.
                  example: something-no-one-will-know
                  type: string
                url:
                  description: URL that webhook events will be sent to.
                  example: https://www.podium.com/
                  type:
                  - string
                  - 'null'
              required:
              - eventTypes
              - url
              type: object
        description: Create webhook params
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/webhook'
                  metadata:
                    description: Additional response data.
                    properties:
                      url:
                        description: The resource URL.
                        example: https://www.podium.com/
                        type: string
                    type: object
                type: object
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                properties:
                  code:
                    description: Podium code for the error.
                    type: integer
                  message:
                    description: Specific details about the error.
                    type:
                    - string
                    - 'null'
                  moreInfo:
                    description: URL providing more information about the error.
                    type: string
                title: Error
                type: object
          description: Error response.
      summary: Create a webhook.
      tags:
      - Webhook
  /v4/webhooks/{uid}:
    delete:
      callbacks: {}
      description: 'Deletes an existing webhook.


        Required scope: none.

        '
      operationId: webhook.delete
      parameters:
      - description: Podium unique identifier for webhook.
        in: path
        name: uid
        required: true
        schema:
          example: 00000000-0000-0000-0000-000000000000
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/webhook'
                  metadata:
                    description: Additional response data.
                    properties:
                      url:
                        description: The resource URL.
                        example: https://www.podium.com/
                        type: string
                    type: object
                type: object
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                properties:
                  code:
                    description: Podium code for the error.
                    type: integer
                  message:
                    description: Specific details about the error.
                    type:
                    - string
                    - 'null'
                  moreInfo:
                    description: URL providing more information about the error.
                    type: string
                title: Error
                type: object
          description: Error response.
      summary: Delete a webhook.
      tags:
      - Webhook
    get:
      callbacks: {}
      description: 'Get a webhook based on its uid.


        Required scope: none.

        '
      operationId: webhook.get
      parameters:
      - description: Podium unique identifier for webhook.
        in: path
        name: uid
        required: true
        schema:
          example: 00000000-0000-0000-0000-000000000000
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/webhook'
                  metadata:
                    description: Additional response data.
                    properties:
                      url:
                        description: The resource URL.
                        example: https://www.podium.com/
                        type: string
                    type: object
                type: object
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                properties:
                  code:
                    description: Podium code for the error.
                    type: integer
                  message:
                    description: Specific details about the error.
                    type:
                    - string
                    - 'null'
                  moreInfo:
                    description: URL providing more information about the error.
                    type: string
                title: Error
                type: object
          description: Error response.
      summary: Get a webhook.
      tags:
      - Webhook
    put:
      callbacks: {}
      description: 'Updates an existing webhook.

        The location uid and organization uid cannot be updated.

        All other parameters not provided will be left unchanged.


        Required scope: The required scope(s) will depend on the event type(s) you are subscribing too. See the WEBHOOK EVENT TYPES section.

        '
      operationId: webhook.update
      parameters:
      - description: Podium unique identifier for webhook.
        in: path
        name: uid
        required: true
        schema:
          example: 00000000-0000-0000-0000-000000000000
          format: uuid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                disabled:
                  description: Disable or enable the webhook.
                  type: boolean
                eventTypes:
                  items:
                    description: Event types that will be sent to webhook.
                    enum:
                    - call.completed
                    - call.missed
                    - call.received
                    - call.voicemail_left
                    - contact.created
                    - contact.deleted
                    - contact.merged
                    - contact.unchanged
                    - contact.updated
                    - invoice.created
                    - invoice.disabled
                    - invoice.marked_as_paid
                    - invoice.payment_created
                    - invoice.payment_failed
                    - invoice.payment_succeeded
                    - invoice.refund_created
                    - invoice.refund_failed
                    - message.failed
                    - message.received
                    - message.sent
                    - review.created
                    - review.invite_link_created
                    - review.invite_link_updated
                    - review.response_created
                    - review.response_updated
                    - review.updated
                    type: string
                  minItems: 1
                  type: array
                secret:
                  description: Secret used to sign webhook events.
                  example: something-no-one-will-know
                  type: string
                url:
                  description: URL that webhook events will be sent to.
                  example: https://www.podium.com/
                  type:
                  - string
                  - 'null'
              type: object
        description: Update webhook params
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/webhook'
                  metadata:
                    description: Additional response data.
                    properties:
                      url:
                        description: The resource URL.
                        example: https://www.podium.com/
                        type: string
                    type: object
                type: object
          description: Successful response.
        default:
          content:
            application/json:
              schema:
                properties:
                  code:
                    description: Podium code for the error.
                    type: integer
                  message:
                    description: Specific details about the error.
                    type:
                    - string
                    - 'null'
                  moreInfo:
                    description: URL providing more information about the error.
                    type: string
                title: Error
                type: object
          description: Error response.
      summary: Update a webhook.
      tags:
      - Webhook
components:
  schemas:
    webhook:
      description: A webhook.
      properties:
        createdAt:
          description: When the webhook was created.
          example: '2015-01-23T23:50:07Z'
          format: date-time
          type:
          - string
          - 'null'
        disabled:
          description: Whether the webhook is disabled or not.
          type: boolean
        eventTypes:
          items:
            description: Event types that will be sent to webhook.
            enum:
            - call.completed
            - call.missed
            - call.received
            - call.voicemail_left
            - contact.created
            - contact.deleted
            - contact.merged
            - contact.unchanged
            - contact.updated
            - invoice.created
            - invoice.disabled
            - invoice.marked_as_paid
            - invoice.payment_created
            - invoice.payment_failed
            - invoice.payment_succeeded
            - invoice.refund_created
            - invoice.refund_failed
            - message.failed
            - message.received
            - message.sent
            - review.created
            - review.invite_link_created
            - review.invite_link_updated
            - review.response_created
            - review.response_updated
            - review.updated
            type: string
          minItems: 1
          type: array
        locationUid:
          description: Podium unique identifier for location.
          example: 00000000-0000-0000-0000-000000000000
          format: uuid
          type:
          - string
          - 'null'
        organizationUid:
          description: Podium unique identifier for location.
          example: 00000000-0000-0000-0000-000000000000
          format: uuid
          type:
          - string
          - 'null'
        secret:
          description: Secret used to sign webhook events.
          type:
          - string
          - 'null'
        uid:
          description: Podium unique identifier for webhook.
          example: 00000000-0000-0000-0000-000000000000
          format: uuid
          type: string
        updatedAt:
          description: When the webhook was last updated.
          example: '2015-01-23T23:50:07Z'
          format: date-time
          type:
          - string
          - 'null'
        url:
          description: URL that webhook events will be sent to.
          example: https://www.podium.com/
          type:
          - string
          - 'null'
      title: webhook
      type: object