Skip to main content

Retrieve a webhook configuration by ID

GET 
/config/:id

Retrieve a webhook configuration by ID

Request​

Path Parameters

    id stringrequired

    The webhook configuration ID

Responses​

Webhook configuration retrieved successfully

Schema

    id string

    The unique identifier of the webhook

    Example: 123e4567-e89b-12d3-a456-426614174000
    name stringrequired

    The name of the webhook configuration

    Example: Order Created Webhook
    ownerId stringrequired

    The ID of the owner (organization)

    Example: org_12345
    subscribedEvents string[]required

    List of events the webhook is subscribed to

    Possible values: [ORDER_EVENT, PARCEL_EVENT, UNKNOWN]

    Example: ["ORDER_CREATED","ORDER_SHIPPED"]

    dispatchConfig

    object

    required

    oneOf

    type stringrequired

    The type of dispatcher configuration

    Possible values: [mailConfig]

    Example: mailConfig
    email emailrequired

    The email address to send notifications to

    Example: user@example.com
    status string

    The status of the webhook

    Possible values: [ACTIVE, INACTIVE]

    Example: ACTIVE
Loading...