Get Sample Data

Version: v1

Gets sample data

Path Parameters

event_name string required

Query Parameters

subcategory string optional

version int64 optional

Responses

200

A successful response.

Schema

Example

{
  "event_name": "string",
  "version": 0,
  "data": {}
}

Returned when invalid input has been provided. Fix the issue and retry.

Schema

Example

{
  "message": "uid is required",
  "code": "required_field"
}

Returned when access to the resource is unauthorized.

Schema

Example

{
  "message": "access is unauthorized",
  "code": "unauthorized"
}

Returned when access is not allowed due to insufficient permissions.

Schema

Example

{
  "message": "insufficient permissions",
  "code": "forbidden"
}

Returned when the resource does not exist.

Schema

Example

{
  "message": "Requested resource does not exist",
  "code": "resource_not_found"
}

Returned when the client has exceeded the rate limit for this endpoint.

Schema

Example

{
  "message": "Too many requests. Client has exceeded the rate limit for this endpoint.",
  "code": "too_many_requests"
}

Returned when a server error is encountered

Schema

Example

{
  "message": "Server error was encountered",
  "code": "server_error"
}

You can also check this in the UI

This is a quick way to test the configuration of your endpoint, either when adding a new endpoint or when modifying an existing endpoint in the webhooks section of the settings.

Webhooks Test Endpoint

Once you've entered a destination URL and a secret, you can click on the Test Endpoint button to send a test event. A webhook event of type test will be sent to the provided destination URL, and will contain a signature header (like other events) which is generated from the provided secret.

At the end of the test, a popup window will show the result of the test; whether the response from the destination was considered a Success or a Failure. If applicable, it will also show the HTTP response code received from the destination. Please refer to the Errors and Retries section in the Getting Started page for more information on what responses are considered a Success.

Webhooks Test Endpoint Success

Event API Name

test

Example Payload

{
  "eventName": "test",
  "version": 1,
  "data": {
    "target": "http://example.com/fullstory-webhooks",
    "initiatedBy": "daniel@falko.com",
    "message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
    "pirateQuote": "Run a shot across the bow!"
  }
}

Get Sample Data​

You can also check this in the UI​

Event API Name​

Example Payload​

Get Sample Data

You can also check this in the UI

Event API Name

Example Payload