curl --request POST \
  --url https://api.tagada.io/api/public/v1/plugins/v2/deploy-from-url \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://example.com/plugin.zip",
  "pluginId": "checkout-plugin",
  "version": "1.0.0",
  "name": "Checkout Plugin",
  "description": "A checkout plugin",
  "storeId": "store_abc123",
  "mode": "direct-mode"
}
'

{
  "message": "<string>",
  "code": "<string>",
  "issues": [
    {
      "message": "<string>"
    }
  ]
}

plugins-v2

Deploy plugin from URL (V2)

Deploy plugin from URL (CRM feature - uses V2 schema).

⚠️ OVERWRITE MODE: Set ‘overwrite: true’ to replace assets for an existing deployment with the same version.

BEHAVIOR: Overwrite mode will:

Keep the existing deployment record (same deploymentId, blobPrefix)
Keep all instances and routes intact (zero downtime)
Replace assets in blob storage (ZIP + extracted files)
Update the zipUrl in the database
All mounted instances will immediately serve the NEW assets
Old assets are permanently overwritten (NOT REVERSIBLE)

Use overwrite mode when you want to hot-swap plugin assets without recreating instances/routes.

POST

api

public

plugins

deploy-from-url

curl --request POST \
  --url https://api.tagada.io/api/public/v1/plugins/v2/deploy-from-url \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://example.com/plugin.zip",
  "pluginId": "checkout-plugin",
  "version": "1.0.0",
  "name": "Checkout Plugin",
  "description": "A checkout plugin",
  "storeId": "store_abc123",
  "mode": "direct-mode"
}
'

{
  "message": "<string>",
  "code": "<string>",
  "issues": [
    {
      "message": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Enter your API key as: Bearer your-api-key

Body

application/json

url

string<uri>

required

pluginId

string

required

Minimum string length: 1

version

string

required

name

string

required

storeId

string

required

description

string

mode

enum<string>

default:iframe-bridge

Available options:

iframe-bridge,

direct-mode

config

object

Show child attributes

pages

array

landingImgUrl

string<uri>

public

boolean

default:false

overwrite

boolean

default:false

Response

Successful response

Set deployment visibility (V2)Sync deployment config (V2)

Overview

Guides

auth

builder

checkout

payments

block-rules

plugins

plugins-v2

domains

orders

subscriptions

products

events

customers

payment-instruments

3ds

stores

funnels

funnel-sessions

funnel-tracking

health

test

webhooks

promotions

promotion-codes

processors

payment-flows

offers

checkout-offers

radar-sessions

email-templates

shipping

tax-exemptions

Deploy plugin from URL (V2)

Authorizations

Body

Response