v2

latestOpenAPI 3.1.12026-07-2613060964.2 KB

Update Event

Update event description and its linked schema.

patch/v1/{workspace}/event/{url_encoded_event_name}/

Path parameters

workspacestring required

Workspace slug (staging, production, etc.)

url_encoded_event_namestring required

URL encoded event name

Request body

descriptionstring

Description of the event. Can be used to describe which action this event is linked to.

Example request

{
  "description": "Triggered whenever a new user successfully signs up on the platform",
  "payload_schema": {
    "schema": "user_signup_v1"
  }
}

Response

Updated event details

object required