Update Subscription
PUT {{apiPath}}/environments/{{envID}}/subscriptions/{{subscriptionID}}
You can use PUT /environments/{{envID}}/subscriptions/{{subscriptionID}}
to update the attribute values for a subscription resource in the specified environment.
Prerequisites
See Subscriptions (webhooks) for important overview information.
Create a population to get a
popID
. See Create Population. Run Read All Populations to find an existing population.Create an application to get an
appID
. See Application Operations. Run Read All Applications to find an existing application.
Property | Type | Required? |
---|---|---|
name | String[] | Required |
filterOptions.includedActionTypes | String[] | Required |
filterOptions.includedApplications | String[] | Optional |
filterOptions.includedPopulations | String[] | Optional |
httpEndpoint.url | String | Required |
httpEndpoint.headers | String[] | Required |
format | String | Required |
verifyTlsCertificates | Boolean[] | Required |
enabled | Boolean | Required |
See Subscriptions (webhooks) data model for full property descriptions.
Request Body
{"name"=>"UpdatedSubscription", "filterOptions"=>{"includedActionTypes"=>["USER.CREATED", "USER.MODIFIED"], "includedPopulations"=>[{"id"=>"{popID}"}], "includedApplications"=>[{"id"=>"{appID}"}]}, "httpEndpoint"=>{"url"=>"https://subscriptionendpoint.com", "headers"=>{"some-header"=>"some-value"}}, "format"=>"ACTIVITY", "enabled"=>true, "verifyTlsCertificates"=>true, "tlsClientAuthKeyPair"=>{"id"=>"{{keyID}}"}}