Update subscription
Update filter rules or transform expression on a subscription.
PATCH
/topics/{id}/subscriptions/{sub_id}
Update filter rules or transform expression on a subscription.
Authentication
API Key (header: X-API-Key) API Key (cookie: better-auth.session_token)
Path Parameters
id
string
required
path
Topic ID
sub_id
string
required
path
Subscription ID
Request Body required
Request body
application/jsonfilter_rules
object[]
Filter rules for this subscription
Array of:
transform_expression
string
JSONata transform expression
Responses
200
Updated subscription
application/jsonsubscription
unknown
REQUIRED
400
Bad request
401
Unauthorized
404
Not found
curl -X PATCH 'https://hookstream.io/v1/topics/string/subscriptions/string' \ -H 'Authorization: Bearer YOUR_API_TOKEN' \ -H 'Content-Type: application/json' \ -d '{ "filter_rules": [ {} ], "transform_expression": "string"}'
const response = await fetch('https://hookstream.io/v1/topics/string/subscriptions/string', { method: 'PATCH', headers: { "Authorization": "Bearer YOUR_API_TOKEN", "Content-Type": "application/json" }, body: JSON.stringify({ "filter_rules": [ {} ], "transform_expression": "string" })});const data = await response.json();console.log(data);
import requestsheaders = { 'Authorization': 'Bearer YOUR_API_TOKEN'}response = requests.patch('https://hookstream.io/v1/topics/string/subscriptions/string', headers=headers, json={ "filter_rules": [ {} ], "transform_expression": "string"})print(response.json())
package mainimport ( "fmt" "io" "net/http" "strings")func main() { body := strings.NewReader(`{ "filter_rules": [ {} ], "transform_expression": "string"}`) req, _ := http.NewRequest("PATCH", "https://hookstream.io/v1/topics/string/subscriptions/string", body) req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN") req.Header.Set("Content-Type", "application/json") resp, _ := http.DefaultClient.Do(req) defer resp.Body.Close() result, _ := io.ReadAll(resp.Body) fmt.Println(string(result))}
200
Response
{ "subscription": { "id": "<string>", "org_id": "<string>", "env_id": "<string>", "topic_id": "<string>", "destination_id": "<string>", "filter_rules": "<string>", "transform_expression": "<string>", "enabled": 123, "created_at": "<string>", "destination_name": "<string>" }}
API Playground
Try this endpoint
PATCH
/topics/{id}/subscriptions/{sub_id}