Webhooks - PromptLayer

Webhooks can be set up to receive notifications about changes to prompt templates. This functionality is particularly useful for storing prompts in cache, allowing for quicker retrieval without slowing down releases.

Event Payload Format

When an event occurs, we send a POST request with a payload in this structure:

{
  "event_type": "string",
  "details": "object",
  "user_id": "number",
  "workspace_id": "number",
  "timestamp": "ISO 8601 format timestamp",
}

Supported Event Types

We notify you for these events:

Event Type	Description	Details
`prompt_template_created`	When a new prompt template is created.	`prompt_template_name` (string) `prompt_template_version_number` (number) `prompt_template_id` (number)
`prompt_template_version_created`	When a new version of a prompt template is created.	`prompt_template_name` (string) `prompt_template_version_number` (number) `prompt_template_id` (number)
`prompt_template_name_changed`	When a prompt template’s name is changed.	`prompt_template_id` (number) `prompt_template_name` (string) `old_prompt_template_name` (string)
`prompt_template_deleted`	When a prompt template is deleted.	`prompt_template_id` (number) `prompt_template_name` (string)
`prompt_template_label_created`	When a new release label for a prompt template is created.	`prompt_template_id` (number) `prompt_template_name` (string) `prompt_template_version_number` (number) `prompt_template_label` (string)
`prompt_template_label_deleted`	When a release label for a prompt template is deleted.	`prompt_template_id` (number) `prompt_template_name` (string) `prompt_template_version_number` (number) `prompt_template_label` (string)
`prompt_template_label_moved`	When a release label is moved between prompt template versions.	`prompt_template_id` (number) `prompt_template_name` (string) `prompt_template_version_number` (number) `old_prompt_template_version_number` (number) `prompt_template_label` (string)

Note: Creating a new prompt template also creates its first version. However, only the prompt_template_created event is triggered.

Example Payload

{
  "event_type":"prompt_template_label_moved",
  "details":{
    "prompt_template_id":12,
    "prompt_template_name":"Hello",
    "prompt_template_version_number":9,
    "old_prompt_template_version_number":8,
    "prompt_template_label":"prod"
  },
  "user_id":1,
  "workspace_id":1,
  "timestamp":"2023-12-01T22:05:57.924833"
}

Configuring a Webhook

To set up a webhook, go to the Webhook section in the Settings page. Enter the URL of the endpoint you want to send the webhook to and click Submit.