Skip to main content

Audit Logs

Requirements​

There are no prerequisites to start using the Vercel audit logs input. Simply create the input and attach it to a pipeline.

Details​

This input collects audit logs from Vercel via their JSON HTTP POST support.

Prerequisites​

  1. An enterprise Vercel account
  2. The owner role in Vercel assigned to the account who will be doing the configuration.

Setup Instructions​

This input requires having Vercel send POST requests to the Monad API. Once you use this input in a pipeline, the URL to POST to will be https://app.monad.com/api/v2/http/send/{pipeline_id}.

The setup instructions are detailed by Vercel here.

Follow the instructions under Setup Process using HTTP POST.

This input accepts both single json and NDJson.

Each JSON object will be sent to the stream exactly as it is provided.

Authentication​

All requests to this input endpoint require authentication using an organization API key with the pipeline:data:write permission.

API Key Requirements​

The API key must meet the following requirements:

  • Must be an organization API key (not a personal API key)
  • Must have the pipeline:data:write permission, which is included by default in the following roles:
    • Contributor
    • System Administrator
  • Alternatively, the permission can be added to a custom role

Required Headers​

You must include one of the following authentication headers:

  • Authorization: ApiKey <API_KEY>
  • x-api-key: <API_KEY>

The Content-Type header is not required, but if provided, it must be set to application/json.

Response Examples​

Success Response (200)​

{
  "status": "success",
  "count": 1
}

Error Responses​

ResponseDescription
authorization requiredNo authentication header was provided
invalid JWTThe provided JWT token is invalid
failed to get api keyThe API key is no longer valid
access denied: this endpoint requires pipeline:data:writeThe API key lacks the required pipeline:data:write permission
error reading request bodyThe request body contains invalid JSON
An item of this type does not exist.The provided pipeline ID does not exist
pipeline not found or not an HTTP inputThe pipeline exists but is not configured as an HTTP input