Skip to main content

CreateGeofenceRequest

Schema for creating a new geofence.

Supports three geometry types (PRD §3.1):

  • Polygon: Standard GeoJSON Polygon
  • MultiPolygon: Collection of polygons
  • Circle: Point with radius_meters
nameName (string)required

Possible values: non-empty and <= 100 characters

description object
anyOf
string

Possible values: <= 500 characters

geometry objectrequired

GeoJSON geometry (Polygon, MultiPolygon, or Circle)

property name*any

GeoJSON geometry (Polygon, MultiPolygon, or Circle)

webhook_url object
anyOf
string

Possible values: <= 2048 characters

webhook_events object
anyOf
  • Array [
  • string
  • ]
  • metadata object
    anyOf
    object
    group_name object
    anyOf
    string

    Possible values: <= 255 characters

    CreateGeofenceRequest
    {
    "name": "string",
    "description": "string",
    "geometry": {},
    "webhook_url": "string",
    "webhook_events": [
    "string"
    ],
    "metadata": {},
    "group_name": "string"
    }