Sample events

GET

/api/v1/zapier/samples

curl --request GET \
  --url 'https://digize.com/api/v1/zapier/samples?event=example' \
  --header 'x-api-key: <x-api-key>'

• Digize

Example deliveries of an event, shaped as real ones are, for Zapier’s Zap editor to show before one arrives.

Needs the automations:read permission.

Authorizations

• apiKey
• bearer

Parameters

Query Parameters

event

required

An event such as commerce.order.paid.

string

An event such as commerce.order.paid.

Responses

200

Done

Media typeapplication/json

Array<object>

object

id

required

string

type

required

string

created_at

required

string

workspace_id

required

string

data

required

object

key

additional properties

Example ^generated

[
  {
    "id": "example",
    "type": "example",
    "created_at": "example",
    "workspace_id": "example",
    "data": {
      "additionalProperty": "example"
    }
  }
]

400

What was sent isn’t valid (invalid).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

401

No key, or one that’s unknown, off or expired.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

403

The key doesn’t have the permission this needs.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

404

Nothing has that id (not_found).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

429

Over the rate limit; see retry-after.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}