Webhooks

(webhooks())

Available Operations

activateConfig - Activate one config
changeConfigSecret - Change the signing secret of a config
deactivateConfig - Deactivate one config
deleteConfig - Delete one config
getManyConfigs - Get many configs
insertConfig - Insert a new config
testConfig - Test one config

activateConfig

Activate a webhooks config by ID, to start receiving webhooks to its endpoint.

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Security;
import com.formance.formance_sdk.utils.EventStream;
import java.math.BigDecimal;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import org.openapitools.jackson.nullable.JsonNullable;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) throws Exception {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            ActivateConfigRequest req = ActivateConfigRequest.builder()
                .id("4997257d-dfb6-445b-929c-cbe2ab182818")
                .build();

            ActivateConfigResponse res = sdk.webhooks().activateConfig()
                .request(req)
                .call();

            if (res.configResponse().isPresent()) {
                // handle response
            }
        } catch (com.formance.formance_sdk.models.errors.WebhooksErrorResponse e) {
            // handle exception
            throw e;
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
            throw e;
        } catch (Exception e) {
            // handle exception
            throw e;
        }
    }
}

Parameters

Parameter	Type	Required	Description
`request`	com.formance.formance_sdk.models.operations.ActivateConfigRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.ActivateConfigResponse>

Errors

Error Object	Status Code	Content Type
models/errors/WebhooksErrorResponse	default	application/json
models/errors/SDKError	4xx-5xx	/

changeConfigSecret

Change the signing secret of the endpoint of a webhooks config.

If not passed or empty, a secret is automatically generated. The format is a random string of bytes of size 24, base64 encoded. (larger size after encoding)

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Security;
import com.formance.formance_sdk.utils.EventStream;
import java.math.BigDecimal;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import org.openapitools.jackson.nullable.JsonNullable;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) throws Exception {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            ChangeConfigSecretRequest req = ChangeConfigSecretRequest.builder()
                .id("4997257d-dfb6-445b-929c-cbe2ab182818")
                .configChangeSecret(ConfigChangeSecret.builder()
                    .secret("V0bivxRWveaoz08afqjU6Ko/jwO0Cb+3")
                    .build())
                .build();

            ChangeConfigSecretResponse res = sdk.webhooks().changeConfigSecret()
                .request(req)
                .call();

            if (res.configResponse().isPresent()) {
                // handle response
            }
        } catch (com.formance.formance_sdk.models.errors.WebhooksErrorResponse e) {
            // handle exception
            throw e;
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
            throw e;
        } catch (Exception e) {
            // handle exception
            throw e;
        }
    }
}

Parameters

Parameter	Type	Required	Description
`request`	com.formance.formance_sdk.models.operations.ChangeConfigSecretRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.ChangeConfigSecretResponse>

Errors

Error Object	Status Code	Content Type
models/errors/WebhooksErrorResponse	default	application/json
models/errors/SDKError	4xx-5xx	/

deactivateConfig

Deactivate a webhooks config by ID, to stop receiving webhooks to its endpoint.

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Security;
import com.formance.formance_sdk.utils.EventStream;
import java.math.BigDecimal;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import org.openapitools.jackson.nullable.JsonNullable;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) throws Exception {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            DeactivateConfigRequest req = DeactivateConfigRequest.builder()
                .id("4997257d-dfb6-445b-929c-cbe2ab182818")
                .build();

            DeactivateConfigResponse res = sdk.webhooks().deactivateConfig()
                .request(req)
                .call();

            if (res.configResponse().isPresent()) {
                // handle response
            }
        } catch (com.formance.formance_sdk.models.errors.WebhooksErrorResponse e) {
            // handle exception
            throw e;
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
            throw e;
        } catch (Exception e) {
            // handle exception
            throw e;
        }
    }
}

Parameters

Parameter	Type	Required	Description
`request`	com.formance.formance_sdk.models.operations.DeactivateConfigRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.DeactivateConfigResponse>

Errors

Error Object	Status Code	Content Type
models/errors/WebhooksErrorResponse	default	application/json
models/errors/SDKError	4xx-5xx	/

deleteConfig

Delete a webhooks config by ID.

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Security;
import com.formance.formance_sdk.utils.EventStream;
import java.math.BigDecimal;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import org.openapitools.jackson.nullable.JsonNullable;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) throws Exception {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            DeleteConfigRequest req = DeleteConfigRequest.builder()
                .id("4997257d-dfb6-445b-929c-cbe2ab182818")
                .build();

            DeleteConfigResponse res = sdk.webhooks().deleteConfig()
                .request(req)
                .call();

            // handle response
        } catch (com.formance.formance_sdk.models.errors.WebhooksErrorResponse e) {
            // handle exception
            throw e;
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
            throw e;
        } catch (Exception e) {
            // handle exception
            throw e;
        }
    }
}

Parameters

Parameter	Type	Required	Description
`request`	com.formance.formance_sdk.models.operations.DeleteConfigRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.DeleteConfigResponse>

Errors

Error Object	Status Code	Content Type
models/errors/WebhooksErrorResponse	default	application/json
models/errors/SDKError	4xx-5xx	/

getManyConfigs

Sorted by updated date descending

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Security;
import com.formance.formance_sdk.utils.EventStream;
import java.math.BigDecimal;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import org.openapitools.jackson.nullable.JsonNullable;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) throws Exception {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            GetManyConfigsRequest req = GetManyConfigsRequest.builder()
                .endpoint("https://example.com")
                .id("4997257d-dfb6-445b-929c-cbe2ab182818")
                .build();

            GetManyConfigsResponse res = sdk.webhooks().getManyConfigs()
                .request(req)
                .call();

            if (res.configsResponse().isPresent()) {
                // handle response
            }
        } catch (com.formance.formance_sdk.models.errors.WebhooksErrorResponse e) {
            // handle exception
            throw e;
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
            throw e;
        } catch (Exception e) {
            // handle exception
            throw e;
        }
    }
}

Parameters

Parameter	Type	Required	Description
`request`	com.formance.formance_sdk.models.operations.GetManyConfigsRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.GetManyConfigsResponse>

Errors

Error Object	Status Code	Content Type
models/errors/WebhooksErrorResponse	default	application/json
models/errors/SDKError	4xx-5xx	/

insertConfig

Insert a new webhooks config.

The endpoint should be a valid https URL and be unique.

The secret is the endpoint's verification secret. If not passed or empty, a secret is automatically generated. The format is a random string of bytes of size 24, base64 encoded. (larger size after encoding)

All eventTypes are converted to lower-case when inserted.

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Security;
import com.formance.formance_sdk.utils.EventStream;
import java.math.BigDecimal;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import org.openapitools.jackson.nullable.JsonNullable;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) throws Exception {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            ConfigUser req = ConfigUser.builder()
                .endpoint("https://example.com")
                .eventTypes(java.util.List.of(
                        "TYPE1",
                        "TYPE2"))
                .name("customer_payment")
                .secret("V0bivxRWveaoz08afqjU6Ko/jwO0Cb+3")
                .build();

            InsertConfigResponse res = sdk.webhooks().insertConfig()
                .request(req)
                .call();

            if (res.configResponse().isPresent()) {
                // handle response
            }
        } catch (com.formance.formance_sdk.models.errors.WebhooksErrorResponse e) {
            // handle exception
            throw e;
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
            throw e;
        } catch (Exception e) {
            // handle exception
            throw e;
        }
    }
}

Parameters

Parameter	Type	Required	Description
`request`	com.formance.formance_sdk.models.shared.ConfigUser	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.InsertConfigResponse>

Errors

Error Object	Status Code	Content Type
models/errors/WebhooksErrorResponse	default	application/json
models/errors/SDKError	4xx-5xx	/

testConfig

Test a config by sending a webhook to its endpoint.

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Security;
import com.formance.formance_sdk.utils.EventStream;
import java.math.BigDecimal;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import org.openapitools.jackson.nullable.JsonNullable;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) throws Exception {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            TestConfigRequest req = TestConfigRequest.builder()
                .id("4997257d-dfb6-445b-929c-cbe2ab182818")
                .build();

            TestConfigResponse res = sdk.webhooks().testConfig()
                .request(req)
                .call();

            if (res.attemptResponse().isPresent()) {
                // handle response
            }
        } catch (com.formance.formance_sdk.models.errors.WebhooksErrorResponse e) {
            // handle exception
            throw e;
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
            throw e;
        } catch (Exception e) {
            // handle exception
            throw e;
        }
    }
}

Parameters

Parameter	Type	Required	Description
`request`	com.formance.formance_sdk.models.operations.TestConfigRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.TestConfigResponse>

Errors

Error Object	Status Code	Content Type
models/errors/WebhooksErrorResponse	default	application/json
models/errors/SDKError	4xx-5xx	/

Files

README.md

Latest commit

History

README.md

File metadata and controls

Webhooks

Available Operations

activateConfig

Example Usage

Parameters

Response

Errors

changeConfigSecret

Example Usage

Parameters

Response

Errors

deactivateConfig

Example Usage

Parameters

Response

Errors

deleteConfig

Example Usage

Parameters

Response

Errors

getManyConfigs

Example Usage

Parameters

Response

Errors

insertConfig

Example Usage

Parameters

Response

Errors

testConfig

Example Usage

Parameters

Response

Errors