Skip to documentation
Integrations & eventsEvents

Events

Methods, permissions, request fields and response schemas for events.

Read and search

Retrieve current records, history and status.

Resume the organization event feedResume event processing from a cursor using thin resource identifiers.GET/developer/events
Token scope events:readActor permission ownerAction type read

Before you use it

Fetch resource context with a separately scoped API call. Events are durable and webhook delivery is at least once; duplicate and out-of-order deliveries are possible.

Pagination: limit 1–100, default 50; cursor is an opaque decimal string. Persist lastCursor after each successful poll. Optional type narrows the feed.

Query parameters

FieldTypeDescription and constraints
limitOptionalintegerMinimum 1 · Maximum 100
cursorOptionalstring

Opaque decimal sequence cursor from this feed's prior response. Send as a string.

At least 1 characters · At most 19 characters · Pattern: ^[0-9]+$
typeOptionalstringOne of: "profile.created", "profile.updated", "profile.deleted", "rental.created", "rental.updated", "rental.deleted", "chat.message.created", "chat.message.deleted", "webhook.test"
Explore this request

Edit example fields and validate the request against its schema.

What you receive

{data:[{cursor,id,type,data,timestamp}],nextCursor,lastCursor,hasMore}. Event data is thin resource identifiers with no message body, credential or hidden text.

Request example · cURL

Replace example IDs and values. Supply the token from your secret store. Each intended write uses one stable $ACTION_KEY.

curl -X GET "$BASE/developer/events?limit=20" \
  -H "Authorization: Bearer $ALLPROFILES_API_TOKEN"
Success response schema · HTTP 200
{
  "application/json": {
    "schema": {
      "type": "object",
      "properties": {
        "data": {
          "type": "array",
          "items": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "cursor": {
                    "type": "string",
                    "minLength": 0,
                    "maxLength": 5000
                  },
                  "id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "type": {
                    "type": "string",
                    "enum": [
                      "profile.created",
                      "profile.updated",
                      "profile.deleted"
                    ]
                  },
                  "timestamp": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "data": {
                    "type": "object",
                    "properties": {
                      "profileId": {
                        "type": "string",
                        "format": "uuid"
                      },
                      "status": {
                        "type": "string",
                        "enum": [
                          "available",
                          "rented",
                          "unlisted"
                        ]
                      },
                      "platform": {
                        "type": "string",
                        "enum": [
                          "linkedin",
                          "facebook",
                          "x",
                          "upwork",
                          "reddit"
                        ]
                      }
                    },
                    "required": [
                      "profileId",
                      "status",
                      "platform"
                    ],
                    "additionalProperties": false
                  }
                },
                "required": [
                  "cursor",
                  "id",
                  "type",
                  "timestamp",
                  "data"
                ],
                "additionalProperties": true
              },
              {
                "type": "object",
                "properties": {
                  "cursor": {
                    "type": "string",
                    "minLength": 0,
                    "maxLength": 5000
                  },
                  "id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "type": {
                    "type": "string",
                    "enum": [
                      "rental.created",
                      "rental.updated",
                      "rental.deleted"
                    ]
                  },
                  "timestamp": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "data": {
                    "type": "object",
                    "properties": {
                      "rentalId": {
                        "type": "string",
                        "format": "uuid"
                      },
                      "profileId": {
                        "type": "string",
                        "format": "uuid"
                      },
                      "status": {
                        "type": "string",
                        "enum": [
                          "active",
                          "completed",
                          "cancelled"
                        ]
                      },
                      "paymentStatus": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "minLength": 0,
                        "maxLength": 5000
                      }
                    },
                    "required": [
                      "rentalId",
                      "profileId",
                      "status",
                      "paymentStatus"
                    ],
                    "additionalProperties": false
                  }
                },
                "required": [
                  "cursor",
                  "id",
                  "type",
                  "timestamp",
                  "data"
                ],
                "additionalProperties": true
              },
              {
                "type": "object",
                "properties": {
                  "cursor": {
                    "type": "string",
                    "minLength": 0,
                    "maxLength": 5000
                  },
                  "id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "type": {
                    "type": "string",
                    "enum": [
                      "chat.message.created",
                      "chat.message.deleted"
                    ]
                  },
                  "timestamp": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "data": {
                    "type": "object",
                    "properties": {
                      "messageId": {
                        "type": "string",
                        "format": "uuid"
                      },
                      "conversationId": {
                        "type": "string",
                        "format": "uuid"
                      },
                      "senderId": {
                        "type": "string",
                        "format": "uuid"
                      },
                      "kind": {
                        "type": "string",
                        "enum": [
                          "text",
                          "system"
                        ]
                      }
                    },
                    "required": [
                      "messageId",
                      "conversationId",
                      "senderId",
                      "kind"
                    ],
                    "additionalProperties": false
                  }
                },
                "required": [
                  "cursor",
                  "id",
                  "type",
                  "timestamp",
                  "data"
                ],
                "additionalProperties": true
              },
              {
                "type": "object",
                "properties": {
                  "cursor": {
                    "type": "string",
                    "minLength": 0,
                    "maxLength": 5000
                  },
                  "id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "type": {
                    "type": "string",
                    "enum": [
                      "webhook.test"
                    ]
                  },
                  "timestamp": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "data": {
                    "type": "object",
                    "properties": {
                      "endpointId": {
                        "type": "string",
                        "format": "uuid"
                      }
                    },
                    "required": [
                      "endpointId"
                    ],
                    "additionalProperties": false
                  }
                },
                "required": [
                  "cursor",
                  "id",
                  "type",
                  "timestamp",
                  "data"
                ],
                "additionalProperties": true
              }
            ]
          }
        },
        "nextCursor": {
          "type": [
            "string",
            "null"
          ],
          "minLength": 0,
          "maxLength": 5000
        },
        "lastCursor": {
          "type": [
            "string",
            "null"
          ],
          "minLength": 0,
          "maxLength": 5000
        },
        "hasMore": {
          "type": "boolean"
        },
        "retentionDays": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        "retainedSince": {
          "type": "string",
          "format": "date-time"
        },
        "prunedThroughCursor": {
          "type": "string",
          "minLength": 0,
          "maxLength": 5000
        }
      },
      "required": [
        "data",
        "nextCursor",
        "lastCursor",
        "hasMore",
        "retentionDays",
        "retainedSince",
        "prunedThroughCursor"
      ],
      "additionalProperties": true
    }
  }
}
Errors and recovery
400
Invalid JSON, request fields, query, path identifier or missing Idempotency-Key.
401
Missing, invalid, revoked or expired organization API token; its issuing actor must still be the current organization owner.
403
Token scope or actor capability denied, disabled/banned account, or action unavailable.
404
Unknown route or resource not accessible in the bound organization. Cross-tenant resources are not enumerated.
409
Conflicting profile/rental state, duplicate resource, idempotency payload mismatch or operation still in progress.
410
event_cursor_expired: the event cursor is behind retained history. Reconcile current resources and start from the supplied recovery cursor.
422
Business validation/moderation rejected the operation. CHAT_MESSAGE_BLOCKED was not delivered.
429
API rate/concurrency limit exceeded; use backoff and Retry-After when present.
500
Internal operation error. Sensitive implementation details are not returned. Investigate using the request ID before repeating a write.
503
Provider or configuration unavailable; uncertain writes must retain the same Idempotency-Key.

These are documented API errors. The local sandbox checks schema fields only and does not test authorization, moderation or provider behavior.

Financial fields named ...Cents or ...InCents use integer cents. Path fields and nested constraints are shown above and in the downloadable OpenAPI contract.