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

PropertyTypeRequired?
nameString[]Required
filterOptions.includedActionTypesString[]Required
filterOptions.includedApplicationsString[]Optional
filterOptions.includedPopulationsString[]Optional
httpEndpoint.urlStringRequired
httpEndpoint.headersString[]Required
formatStringRequired
verifyTlsCertificatesBoolean[]Required
enabledBooleanRequired

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}}"}}