Copper · Schema

Webhook

ActivitiesCompaniesContact Relationship ManagementContactsCRMCustomer Relationship ManagementGoogle WorkspaceLeadsOpportunitiesPeopleProjectsSalesTasks

Properties

Name Type Description
id integer
target string
event string
type string
secret object
View JSON Schema on GitHub

JSON Schema

copper-webhook-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Webhook",
  "title": "Webhook",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64"
    },
    "target": {
      "type": "string",
      "format": "uri"
    },
    "event": {
      "type": "string",
      "enum": [
        "new",
        "update",
        "delete"
      ]
    },
    "type": {
      "type": "string",
      "enum": [
        "person",
        "company",
        "lead",
        "opportunity",
        "project",
        "task"
      ]
    },
    "secret": {
      "type": "object",
      "properties": {
        "secret": {
          "type": "string"
        }
      }
    }
  }
}