Operations 16
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
POST
/{clientId}/webhooks/{webhookId}/activate
Activate a client's event webhook · Activate a webhook
#
Ask an LLM
“How do I switch on a webhook so it starts sending event data for my client account?”
“Can I reactivate a webhook that I paused earlier?”
Tell an agent
Activate webhook {webhookId} for client {clientId}.
Start sending event data on webhook {webhookId} in client {clientId}.
Ask an LLM
“Which webhooks are set up for my client account and are they active?”
“Can I sort my client's webhooks and page through them with offset and limit?”
Tell an agent
List all webhooks for client {clientId}.
Show {limit} webhooks for client {clientId} sorted by {sort}.
Ask an LLM
“How do I create a webhook that pushes event data to my URL for a client account?”
“Can a client webhook use basic auth when calling my target URL?”
Tell an agent
Create a {type} webhook for client {clientId} that posts {format} data to {targetUrl}.
Set up a client {clientId} webhook to {targetUrl} with basic auth user {basicAuthUsername}.
POST
/{clientId}/webhooks/{webhookId}/deactivate
Pause a client's event webhook · Deactivate a webhook
#
Ask an LLM
“How do I stop a webhook from sending event data without deleting it?”
“Can I temporarily turn off a client webhook?”
Tell an agent
Deactivate webhook {webhookId} for client {clientId}.
Stop event delivery on webhook {webhookId} in client {clientId} but keep it configured.
PUT
/{clientId}/webhooks/{webhookId}
Change a client webhook's target or format · Update a webhook
#
Ask an LLM
“How do I point an existing client webhook at a new target URL?”
“Can I change the data format a client webhook sends?”
Tell an agent
Update webhook {webhookId} in client {clientId} to send to {targetUrl}.
Switch client {clientId} webhook {webhookId} to {format} format.
Ask an LLM
“How do I permanently remove a webhook from my client account?”
“What happens if I delete a client webhook instead of deactivating it?”
Tell an agent destructive · confirm first
Delete webhook {webhookId} from client {clientId}.
Permanently remove client {clientId}'s webhook {webhookId}.
GET
/{clientId}/webhooks/{webhookId}/verify
Test a client webhook against its target URL · Verify a webhook
#
Ask an LLM
“How do I check that my webhook's target URL is ready before going live?”
“Can I send a few test events for a mailing to verify a webhook?”
Tell an agent
Verify webhook {webhookId} in client {clientId} using mailing {mailingId}.
Send {numberOfEvents} test events from mailing {mailingId} to webhook {webhookId} of client {clientId}.
Ask an LLM
“What webhooks are registered on the /api/webhooks endpoint for content events?”
“Can I see every webhook handler along with its topics and filters?”
Tell an agent
List all webhooks registered under /api/webhooks.
Show me every registered webhook handler and the topics it listens to.
Ask an LLM
“How do I register a webhook that listens only to certain topics?”
“If I leave the filter empty, will the webhook receive every event?”
Tell an agent
Register a webhook that sends request {request} for topics {topics}.
Add a webhook handler with request {request} and filters {filters}.
Ask an LLM
“How do I unregister a webhook handler from /api/webhooks?”
“Can I remove a registered content webhook by its id?”
Tell an agent destructive · confirm first
Unregister webhook handler {id}.
Delete the registered /api/webhooks entry {id}.
Ask an LLM
“How do I change the topics or filters of a webhook I already registered?”
“Can I disable a registered webhook handler without deleting it?”
Tell an agent
Update registered webhook {id} to listen to topics {topics}.
Set disabled to {disabled} on webhook handler {id} with request {request}.
GET
/projects/{project_id}/webhooks
List webhooks in an experimentation project · Get Webhooks by Project
#
Ask an LLM
“Which webhooks exist in my Optimizely experimentation project?”
“Can I page through a project's webhooks using a page token?”
Tell an agent
List the webhooks in project {project_id}.
Show {per_page} webhooks per page for project {project_id}.
Ask an LLM
“How do I get notified at my URL when events happen in a project?”
“What name, description and events must a new project webhook have?”
Tell an agent
Create a webhook {name} in project {project_id} that calls {url} on events {events}.
Add a project {project_id} webhook to {url} described as {description}.
Ask an LLM
“How do I remove a webhook from an experimentation project?”
“Can I delete a project webhook knowing only its webhook_id?”
Tell an agent destructive · confirm first
Delete project webhook {webhook_id}.
Remove the experimentation webhook {webhook_id}.
Ask an LLM
“How do I see all the properties of a single project webhook?”
“Which events and URL is a particular project webhook configured with?”
Tell an agent
Get project webhook {webhook_id}.
Show the URL and events for webhook {webhook_id}.
Ask an LLM
“How do I change the URL or subscribed events of a project webhook?”
“Can I rename an existing experimentation webhook?”
Tell an agent
Update project webhook {webhook_id} to call {url}.
Change the events on project webhook {webhook_id} to {events}.