Create Subscriptions
POST {{apiPath}}/environments/{{envID}}/subscriptions
You can use POST /environments/{{envID}}/subscriptions/ to create a new subscriptions resource in the specified environment.
Note: The service supports a maximum of 50 subscriptions. Attempts to create more than 50 subscriptions result in a 403 Forbidden error.
Prerequisites
The webhook needs to be configured only for IPv4 addresses. IPv6 addresses are not fully-supported.
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 |
filterOptions.ipAddressExposed | Boolean | Optional |
filterOptions.userAgentExposed | Boolean | 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"=>"SubscriptionName1", "filterOptions"=>{"includedActionTypes"=>["USER.CREATED", "USER.UPDATED"], "includedPopulations"=>[{"id"=>"{{popID}}"}], "includedApplications"=>[{"id"=>"{{appID}}"}]}, "httpEndpoint"=>{"url"=>"https://subscriptionendpoint.com", "headers"=>{"some-header"=>"some-value"}}, "format"=>"ACTIVITY", "verifyTlsCertificates"=>true, "tlsClientAuthKeyPair"=>{"id"=>"{{keyID}}"}, "enabled"=>true}
RESPONSES
status: Created
{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/subscriptions/9773fa25-a4f4-40d8-ac25-0d53338247c1"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"id":"9773fa25-a4f4-40d8-ac25-0d53338247c1","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"name":"SubscriptionName1","filterOptions":{"includedActionTypes":["USER.CREATED","USER.UPDATED"],"includedPopulations":[{"id":"60971d3b-cc5a-4601-9c44-2be541f91bf1"}],"includedApplications":[{"id":"cdecf42f-9fdb-4b46-a75d-6ff608a4109d"}]},"httpEndpoint":{"url":"https://subscriptionendpoint.com","headers":{"some-header":"some-value"}},"format":"ACTIVITY","enabled":true,"createdAt":"2021-03-15T22:30:48.958Z","verifyTlsCertificates":true,"tlsClientAuthKeyPair":{"id":"56efz334-20d1-4861-8c45-6d0ccfd4db4e"}}