USusefathom
Events

Create event

Changed on

Previously created an event. This endpoint is no longer available.

Permissions: Requires write access to the site (manage:{site_id}).

post/sites/{site_id}/events

Request

  • Base URL
    https://api.usefathom.com/v1
  • URL
    https://api.usefathom.com/v1/sites/{site_id}/events
  • Auth
    HTTP bearer

Path parameters

site_idstring required
Example:CDBUGS

The ID of the site. This is the same string you use in your tracking code. Example: CDBUGS

Request body

namestring required

The name of the event (up to 255 characters). Example: Purchase early access

currency'dollar' | 'pound' | 'euro' | 'yuan' | 'peso' | 'shekel' | 'yen' | 'won' | 'hryvnia' | 'franc' | 'rupee' | 'integer' | 'none'

The currency used for any value attached to this event's completions. If omitted, defaults to dollar.

Example request

{
  "name": "Purchase early access"
}

Changes

  • 93547ee49398Revision changes
    • breaking

      removed the success response with the status

    • info

      endpoint deprecated

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

  • 50679caad756Revision changes
    • breaking

      added the new path request parameter site_id

    • info

      api operation id createEvent was added

    • info

      api tag Events added

    • info

      added the new optional request property

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status