Generated by API Evangelist
Written by API Evangelist tooling for Meltwater's API. It is a proposal applied on top of the contract, not a document Meltwater publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Meltwater Listening Streaming API
version: 1.0.0
extends: openapi/meltwater-listening-streaming-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 4
- target: $.paths['/v3/hooks'].get
update:
x-apievangelist-phrasing:
intent: List my streaming hooks
effect: read
questions:
- Which streaming hooks have I set up?
- Where can I see every webhook currently receiving search results?
instructions:
- text: List all my streaming hooks.
- text: Show every hook I've created.
method: generated
generated: '2026-09-26'
- target: $.paths['/v3/hooks'].post
update:
x-apievangelist-phrasing:
intent: Stream a saved search's results to a URL
effect: write
questions:
- How do I get Meltwater search results pushed to my own endpoint in real time?
- Can I sign the streamed payloads with a secret so I can verify them?
- What do I need to keep after creating a hook so I can delete it later?
instructions:
- text: Stream results for search {search_id} to {target_url}.
slots:
search_id: requestBody.search_id
target_url: requestBody.target_url
- text: Create a hook sending search {search_id} results to {target_url}, signed with secret {secret}.
slots:
search_id: requestBody.search_id
target_url: requestBody.target_url
secret: header.X-Hook-Secret
- text: Push search {search_id} to {target_url} using template {template}.
slots:
search_id: requestBody.search_id
target_url: requestBody.target_url
template: requestBody.template
method: generated
generated: '2026-09-26'
- target: $.paths['/v3/hooks/{hook_id}'].get
update:
x-apievangelist-phrasing:
intent: Get one streaming hook
effect: read
questions:
- Which search and target URL is a particular hook tied to?
- How do I look up an existing hook by its ID?
instructions:
- text: Show hook {hook_id}.
slots:
hook_id: path.hook_id
- text: Look up where streaming hook {hook_id} delivers results.
slots:
hook_id: path.hook_id
method: generated
generated: '2026-09-26'
- target: $.paths['/v3/hooks/{hook_id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a streaming hook
effect: destructive
questions:
- How do I stop search results being sent to my endpoint?
- Does deleting a hook stop delivery to the target URL right away?
instructions:
- text: Delete hook {hook_id}.
slots:
hook_id: path.hook_id
- text: Stop streaming hook {hook_id} from sending any more results.
slots:
hook_id: path.hook_id
method: generated
generated: '2026-09-26'
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.