Tweed Docs
  • Welcome to Tweed
    • What Can Tweed Do?
  • Getting Started
    • Embedded Wallets | WaaS
    • Token Checkout | Payments
      • Flow of Funds: Purchase to Settlement
      • Token Checkout
      • Legacy Token Checkout
        • Basic Checkout Integration
        • Checkout + WaaS + Auth
        • Features
          • Payment links
          • Whitelist
          • Flow of Funds
          • Apple & Google Pay
          • AML & KYC Policy Overview
  • Developer Tools
    • Tweed SDKs
      • core-react
        • useAuth
        • useWallet
        • useTweed
        • usePayments
        • useWeb3
      • core-js
      • core-vue
      • Payments SDKs (v1)
        • Frontend SDKs (Payments)
        • Backend SDK (Payments)
        • How to set up your smart contract for Tweed
        • Tezos chain considerations
    • Management Dashboard
      • Create platform
      • Create application
        • UI Customization
    • Webhooks
      • Checkout Webhooks
    • API
      • API (V1)
      • API (V2)
        • Authorization
        • API reference
          • Contracts
            • Add
            • Add contract function
            • Contract
          • Payouts
            • Add
            • Payout
          • Items
            • Add
            • All
              • Contract
                • Count
              • Payout
                • Count
          • Assets
            • Blockchain
            • All
              • Blockchains
          • Blockchains
            • Multiple
            • Native asset
          • Audit event mappings
          • Platform webhooks
            • Set active
          • Tickets
        • Specification
    • External Integrations
      • Wagmi connector
      • Onramp to Crypto
    • Example Projects
    • Supported Blockchains
    • Pricing
  • Products
    • WaaS
    • Payments
Powered by GitBook
On this page
  1. Developer Tools
  2. API
  3. API (V2)
  4. API reference

Platform webhooks

PreviousAudit event mappingsNextSet active
delete
Authorizations
Path parameters
idstringRequired
Responses
200Success
delete
DELETE /v1/platform-webhooks/{id} HTTP/1.1
Host: 
Authorization: Bearer Bearer
Accept: */*
200Success

No content

  • GET/v1/platform-webhooks
  • POST/v1/platform-webhooks
  • PUT/v1/platform-webhooks/{id}
  • DELETE/v1/platform-webhooks/{id}
get
Authorizations
Responses
200Success
application/json
get
GET /v1/platform-webhooks HTTP/1.1
Host: 
Authorization: Bearer Bearer
Accept: */*
200Success
[
  {
    "id": "text",
    "url": "text",
    "isActive": true,
    "events": [
      "text"
    ],
    "createdAt": "2025-05-10T22:41:20.502Z",
    "lastUpdatedAt": "2025-05-10T22:41:20.502Z"
  }
]
post
Authorizations
Body
urlstringRequired
eventsstring[]Required
secretstringOptional
Responses
201Success
post
POST /v1/platform-webhooks HTTP/1.1
Host: 
Authorization: Bearer Bearer
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "url": "text",
  "events": [
    "text"
  ],
  "secret": "text"
}
201Success

No content

put
Authorizations
Path parameters
idstringRequired
Body
urlstringOptional
eventsstring[]Optional
secretstringOptional
Responses
200Success
put
PUT /v1/platform-webhooks/{id} HTTP/1.1
Host: 
Authorization: Bearer Bearer
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "url": "text",
  "events": [
    "text"
  ],
  "secret": "text"
}
200Success

No content