Bitly

Bitly Webhooks API

Create, read, update, delete and verify webhook endpoints that receive Bitly engagement events. 6 operation(s), extracted verbatim from the OpenAPI Bitly publishes at https://dev.bitly.com/v4/v4.json.

GitHub OpenAPI

Operations 6

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 /organizations/{organization_guid}/webhooks List an organization's webhooks · Get Webhooks #
Ask an LLM
“Which webhooks are set up for my Bitly organization?”
“Can I see every webhook endpoint configured across an organization?”
Tell an agent
List all webhooks for organization {organization_guid}.
Show me the webhooks configured in organization {organization_guid}.
POST /webhooks Create a webhook · Create Webhook #
Ask an LLM
“How do I get notified at my own URL when an event happens in Bitly?”
“Can a new webhook be limited to a single group instead of the whole organization?”
Tell an agent
Create a webhook named {name} in organization {organization_guid} that sends {event} events to {url}.
Set up a new webhook {name} for group {group_guid} in organization {organization_guid} posting {event} to {url}.
GET /webhooks/{webhook_guid} Get a webhook's configuration · Retrieve Webhook #
Ask an LLM
“What URL and event is a specific webhook configured with?”
“Is a particular webhook currently active?”
Tell an agent
Show webhook {webhook_guid}.
Fetch the configuration of webhook {webhook_guid}.
PATCH /webhooks/{webhook_guid} Update or pause a webhook · Update Webhook #
Ask an LLM
“Can I change the destination URL of an existing webhook?”
“How do I deactivate a webhook without deleting it?”
Tell an agent
Point existing webhook {webhook_guid} at {url}.
Set is_active to {is_active} on webhook {webhook_guid}.
DELETE /webhooks/{webhook_guid} Delete a webhook · Delete Webhook #
Ask an LLM
“How do I remove a webhook I no longer need?”
“Can I permanently stop a webhook rather than just pausing it?”
Tell an agent destructive · confirm first
Delete webhook {webhook_guid}.
Remove the webhook {webhook_guid} permanently.
POST /webhooks/{webhook_guid}/verify Send a test ping to a webhook · Verify Webhook #
Ask an LLM
“How can I test that my webhook endpoint is receiving events?”
“Can I send a ping event to check a webhook's configuration?”
Tell an agent
Send a test ping to webhook {webhook_guid}.
Verify webhook {webhook_guid} is configured correctly.

Documentation

📖
Documentation
https://dev.bitly.com/api-reference
📖
APIReference
https://dev.bitly.com/api-reference
📖
GettingStarted
https://dev.bitly.com/docs/getting-started/introduction

Specifications

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

Other Resources

🔗
PostmanCollection
https://raw.githubusercontent.com/api-evangelist/bitly/refs/heads/main/collections/bitly-webhooks-api.postman_collection.json
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/bitly/refs/heads/main/asyncapi/bitly-engagement-webhooks.yml
🔗
OpenCollection
https://raw.githubusercontent.com/api-evangelist/bitly/refs/heads/main/collections/bitly-webhooks-api.opencollection.json
🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/bitly/refs/heads/main/overlays/bitly-webhooks-overlay.yaml

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/bitly:bitly-webhooks-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

bitly-webhooks-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 4.0.0
  title: Bitly Webhooks API
  termsOfService: https://bitly.com/pages/terms-of-service
  contact:
    url: https://bitly.is/API-support
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  x-logo:
    url: /v4/header-logo.png
  description: Webhooks are a method of sending information from Bitly to an application outside of Bitly. It's a way to automate actions or updates between two different systems. These endpoints are for configuring your webhooks.
servers:
- url: https://api-ssl.bitly.com/v4
security:
- bearerAuth: []
tags:
- name: Webhooks
  description: Webhooks are a method of sending information from Bitly to an application outside of Bitly. It's a way to automate actions or updates between two different systems. These endpoints are for configuring your webhooks.
paths:
  /organizations/{organization_guid}/webhooks:
    get:
      summary: Get Webhooks
      description: Fetch all webhooks available for an Organization
      operationId: getWebhooks
      parameters:
      - $ref: '#/components/parameters/OrganizationGUID'
      tags:
      - Webhooks
      responses:
        '200':
          description: SUCCESS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Webhooks'
        '402':
          description: UPGRADE_REQUIRED
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpgradeRequired'
        '403':
          description: FORBIDDEN
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Forbidden'
        '404':
          description: NOT_FOUND
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
        '429':
          description: MONTHLY_LIMIT_EXCEEDED
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonthlyLimitExceeded'
        '500':
          description: INTERNAL_ERROR
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalError'
        '503':
          description: TEMPORARILY_UNAVAILABLE
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemporarilyUnavailable'
  /webhooks:
    post:
      summary: Create Webhook
      description: Creates a webhook.
      operationId: createWebhook
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookCreate'
      tags:
      - Webhooks
      responses:
        '201':
          description: CREATED
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Webhook'
        '400':
          description: BAD_REQUEST
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequest'
        '402':
          description: UPGRADE_REQUIRED
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpgradeRequired'
        '403':
          description: FORBIDDEN
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Forbidden'
        '404':
          description: NOT_FOUND
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
        '422':
          description: UNPROCESSABLE_ENTITY
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntity'
        '429':
          description: MONTHLY_LIMIT_EXCEEDED
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonthlyLimitExceeded'
        '500':
          description: INTERNAL_ERROR
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalError'
        '503':
          description: TEMPORARILY_UNAVAILABLE
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemporarilyUnavailable'
  /webhooks/{webhook_guid}:
    get:
      summary: Retrieve Webhook
      description: Returns a webhook.
      operationId: getWebhook
      parameters:
      - $ref: '#/components/parameters/WebhookGUID'
      tags:
      - Webhooks
      responses:
        '200':
          description: SUCCESS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Webhook'
        '400':
          description: BAD_REQUEST
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequest'
        '402':
          description: UPGRADE_REQUIRED
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpgradeRequired'
        '403':
          description: FORBIDDEN
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Forbidden'
        '404':
          description: NOT_FOUND
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
        '429':
          description: MONTHLY_LIMIT_EXCEEDED
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonthlyLimitExceeded'
        '500':
          description: INTERNAL_ERROR
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalError'
        '503':
          description: TEMPORARILY_UNAVAILABLE
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemporarilyUnavailable'
    patch:
      summary: Update Webhook
      description: Update a webhook
      operationId: updateWebhook
      parameters:
      - $ref: '#/components/parameters/WebhookGUID'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookUpdate'
      tags:
      - Webhooks
      responses:
        '200':
          description: SUCCESS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Webhook'
        '400':
          description: BAD_REQUEST
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequest'
        '402':
          description: UPGRADE_REQUIRED
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpgradeRequired'
        '403':
          description: FORBIDDEN
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Forbidden'
        '404':
          description: NOT_FOUND
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
        '422':
          description: UNPROCESSABLE_ENTITY
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntity'
        '429':
          description: MONTHLY_LIMIT_EXCEEDED
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonthlyLimitExceeded'
        '500':
          description: INTERNAL_ERROR
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalError'
        '503':
          description: TEMPORARILY_UNAVAILABLE
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemporarilyUnavailable'
    delete:
      summary: Delete Webhook
      description: Deletes a webhook.
      operationId: deleteWebhook
      parameters:
      - $ref: '#/components/parameters/WebhookGUID'
      tags:
      - Webhooks
      responses:
        '204':
          description: SUCCESS
        '400':
          description: BAD_REQUEST
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequest'
        '402':
          description: UPGRADE_REQUIRED
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpgradeRequired'
        '403':
          description: FORBIDDEN
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Forbidden'
        '404':
          description: NOT_FOUND
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
        '500':
          description: INTERNAL_ERROR
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalError'
        '503':
          description: TEMPORARILY_UNAVAILABLE
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemporarilyUnavailable'
  /webhooks/{webhook_guid}/verify:
    post:
      summary: Verify Webhook
      description: Sends ping event to test webhook configuration.
      operationId: verifyWebhook
      parameters:
      - $ref: '#/components/parameters/WebhookGUID'
      tags:
      - Webhooks
      responses:
        '200':
          description: SUCCESS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Webhook'
        '400':
          description: BAD_REQUEST
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequest'
        '402':
          description: UPGRADE_REQUIRED
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpgradeRequired'
        '403':
          description: FORBIDDEN
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Forbidden'
        '404':
          description: NOT_FOUND
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
        '500':
          description: INTERNAL_ERROR
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalError'
        '503':
          description: TEMPORARILY_UNAVAILABLE
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemporarilyUnavailable'
components:
  schemas:
    Forbidden:
      description: FORBIDDEN
      allOf:
      - $ref: '#/components/schemas/Error'
    HasReferences:
      type: object
      properties:
        references:
          type: object
          additionalProperties:
            type: string
    SimplifiedError:
      type: object
      properties:
        message:
          type: string
        description:
          type: string
        resource:
          type: string
    UnprocessableEntity:
      description: UNPROCESSABLE_ENTITY
      allOf:
      - $ref: '#/components/schemas/Error'
    FieldError:
      type: object
      properties:
        field:
          type: string
        error_code:
          type: string
        message:
          type: string
    WebhookCreate:
      type: object
      required:
      - organization_guid
      - name
      - event
      - url
      properties:
        is_active:
          type: boolean
        organization_guid:
          type: string
        group_guid:
          type: string
        name:
          type: string
        event:
          type: string
        url:
          type: string
        oauth_url:
          type: string
        client_id:
          type: string
        client_secret:
          type: string
        fetch_tags:
          type: boolean
      example:
        is_active: true
        organization_guid: Oa1bcd234eF
        group_guid: Ba1bc23dE4F
        name: My Webhook
        event: decodes
        url: https://bitly.com/webhooks
        oauth_url: https://fake.com/oauth
        client_id: fakeclientid123
        client_secret: itsasecreticanttellyou
    BadRequest:
      description: BAD_REQUEST
      allOf:
      - $ref: '#/components/schemas/Error'
    TemporarilyUnavailable:
      description: TEMPORARILY_UNAVAILABLE
      allOf:
      - $ref: '#/components/schemas/Error'
    Webhooks:
      type: object
      properties:
        webhooks:
          type: array
          items:
            $ref: '#/components/schemas/Webhook'
    NotFound:
      description: NOT_FOUND
      allOf:
      - $ref: '#/components/schemas/Error'
    UpgradeRequired:
      description: UPGRADE_REQUIRED
      allOf:
      - $ref: '#/components/schemas/Error'
    Webhook:
      type: object
      allOf:
      - $ref: '#/components/schemas/HasReferences'
      - properties:
          guid:
            type: string
          created:
            type: string
          modified:
            type: string
          modified_by:
            type: string
          alerted:
            type: string
          deactivated:
            type: string
          is_active:
            type: boolean
          is_alert:
            type: boolean
          organization_guid:
            type: string
          group_guid:
            type: string
          name:
            type: string
          event:
            type: string
          url:
            type: string
          status:
            type: string
          oauth_url:
            type: string
          client_id:
            type: string
          client_secret:
            type: string
          fetch_tags:
            type: boolean
      required:
      - guid
      - created
      - modified
      - modified_by
      - alerted
      - deactivated
      - is_active
      - is_alert
      - organization_guid
      - name
      - event
      - url
    WebhookUpdate:
      type: object
      required:
      - guid
      properties:
        guid:
          type: string
        is_active:
          type: boolean
        organization_guid:
          type: string
        group_guid:
          type: string
        name:
          type: string
        event:
          type: string
        url:
          type: string
        oauth_url:
          type: string
        client_id:
          type: string
        client_secret:
          type: string
        fetch_tags:
          type: boolean
      example:
        guid: Wa1bcDefG23
        is_active: true
        organization_guid: Oa1bcd234eF
        group_guid: Ba1bc23dE4F
        name: My Webhook
        event: decodes
        url: https://bitly.com/webhooks
        oauth_url: https://fake.com/oauth
        client_id: fakeclientid123
        client_secret: itsasecreticanttellyou
    MonthlyLimitExceeded:
      description: MONTHLY_LIMIT_EXCEEDED
      allOf:
      - $ref: '#/components/schemas/SimplifiedError'
      example:
        message: API_USAGE_LIMIT_EXCEEDED
    InternalError:
      description: INTERNAL_ERROR
      allOf:
      - $ref: '#/components/schemas/Error'
    Error:
      type: object
      properties:
        message:
          type: string
        description:
          type: string
        resource:
          type: string
        errors:
          type: array
          items:
            $ref: '#/components/schemas/FieldError'
  parameters:
    WebhookGUID:
      name: webhook_guid
      description: A GUID for a Bitly webhook
      in: path
      required: true
      schema:
        type: string
      example: Wa1bcDefG23
    OrganizationGUID:
      name: organization_guid
      description: A GUID for a Bitly organization
      in: path
      required: true
      schema:
        type: string
      example: Oa1bcd234eF
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer