Avid PubSuite Partner API
  1. Webhooks
Avid PubSuite Partner API
  • Pubsuite API Introduction
  • Getting Started
    • Authentication
    • Response Format
    • Error Codes
    • Usage Limits
  • Endpoints
    • Endpoints / Resources Introduction
    • Global Pubsuite Reference Libaries
    • Workspace Organisation Users
      • Organisation Users List
      • Organisation User By Id
    • Advertiser Accounts
      • Advertiser Accounts List
      • Account Detail
      • Account Delete
      • Account Create
      • Account Update
    • Advertiser Account Members
      • Advertiser Account Members
      • Adv Account Member Detail
      • Account Delete
      • Advertiser Account Member Create
      • Account Update
    • Campaigns
      • Campaign Body Parameters
      • Campaigns
      • Campaign
      • Delete Campaign
      • Campaign Details
      • Update Campaign
    • Phases
      • Phase Body Parameters
      • Phases List
      • Phase
      • Phase Detail
      • Delete Phase
      • Phase Update
    • Content
      • Content Body Parameters
      • Contents
      • Content Detail
      • Create Content
      • Delete Content
      • Update Content
    • Distributions
      • Distribution Body Parameters
      • Distributions List
      • Create Distributions
      • Delete Distribution
      • Distribution Details
      • Distribution Update
    • Publisher Profiles
      • Coming Soon
      • Publisher Profiles
      • Publisher Profile
      • Delete Publisher Profile
    • Publisher Products
      • Coming Soon
    • Data Sources
      • Coming Soon
    • Webhooks
      • Services
        GET
      • Create/Update Service
        POST
      • Registered Webhooks
        GET
      • Create Webhook
        POST
      • Update Webhook
        PUT
      • Delete Webhook
        DELETE
  • Outbound Events
    • Outbound Events
  1. Webhooks

Create Webhook

Testing
POST
https://api.avidpubsuite.com/v2/webhooks

Request

Authorization
Add parameter in header
X-API-Key
Example:
X-API-Key: ********************
Header Params

Body Params application/json

Example
{
    "name": "Testing Subscriptions",
    "service_id": "123",
    "events": [
        "campaign_created",
        "campaign_updated",
        "campaign_media_added",
        "content_created",
        "content_updated",
        "distribution_created",
        "distribution_updated"
    ],
    "url": "https://webhook.site/9c619312-4251-4bed-9364-45be626f604a"
}

Responses

🟢200Success
application/json
Body

Example
{
    "success": true,
    "message": "string",
    "data": {
        "webhook": {
            "id": 0,
            "name": "string",
            "events": [
                "string"
            ],
            "url": "string",
            "created_at": "string",
            "updated_at": "string"
        }
    }
}
🟠401Unauthorized
🟠404Resource Not Found
🟠422Unprocessable Entity
🔴500Internal Server Error
Previous
Registered Webhooks
Next
Update Webhook