Version: iOS SDK

Hooks

Set hooks

You can define custom hooks to be executed on various events.

Thanks to this you will be able to interact with your app when a survey or message appears, or execute some custom code when a survey is submitted.

You can define hooks on Screeb.initSdk(), Screeb.startSurvey() and Screeb.startMessage() commands. Hooks use the same SurveyHooks structure and are all optional.

Available hooks

Hook Name	Available on `Screeb.initSdk()`	Available on `Screeb.startSurvey()`	Available on `Screeb.startMessage()`
`onSurveyShowed`	Yes ✅	Yes ✅	Yes ✅
`onSurveyStarted`	Yes ✅	Yes ✅	Yes ✅
`onQuestionReplied`	Yes ✅	Yes ✅	Yes ✅
`onSurveyCompleted`	Yes ✅	Yes ✅	Yes ✅
`onSurveyHidden`	Yes ✅	Yes ✅	Yes ✅
`onAppStoreRatingTriggered`	Yes ✅	Yes ✅	Yes ✅
`onReady`	Yes ✅	No ❌	No ❌
`onSurveyDisplayAllowed`	Yes ✅	No ❌	No ❌
`onMessageShowed`	Yes ✅	Yes ✅	Yes ✅
`onMessageStarted`	Yes ✅	Yes ✅	Yes ✅
`onMessageCompleted`	Yes ✅	Yes ✅	Yes ✅
`onMessageHidden`	Yes ✅	Yes ✅	Yes ✅
`onMessageDisplayAllowed`	Yes ✅	No ❌	No ❌

Set hooks on SDK init

Screeb.initSdk(
    context: window?.rootViewController,
    channelId: "<YOUR-CHANNEL-ID>",
    hooks: [
        "version": "1.0.0",
        "onReady": {(e:Any) -> () in print("Screeb sdk ready " + String(describing: e))},
        "onSurveyDisplayAllowed": {(e:Any) -> Bool in print("onSurveyDisplayAllowed " + String(describing: e)); return true}
    ]
)

Set hooks on survey start

Screeb.startSurvey(
    surveyId: "<survey-id>",
    allowMultipleResponses: true,
    hiddenFields: [
        "iosHidden1": AnyEncodable("hiddenField1"),
        "iosHiddenCount": AnyEncodable(75)
    ],
    hooks: [
        "version": "1.0.0",
        "onSurveyShowed": {(e:Any) -> () in print("Screeb survey showed " + String(describing: e))},
    ]
)

Set hooks on message start

Screeb.startMessage(
    messageId: "<message-id>",
    allowMultipleResponses: true,
    hiddenFields: [
        "iosHidden1": AnyEncodable("hiddenField1"),
        "iosHiddenCount": AnyEncodable(75)
    ],
    hooks: [
        "version": "1.0.0",
        "onSurveyShowed": {(e:Any) -> () in print("Screeb message showed " + String(describing: e))},
    ]
)

`onSurveyShowed`

Called when a survey is showed.

Example

Screeb.initSdk(
    context: nil,
    channelId: "<YOUR-CHANNEL-ID>",
    hooks: [
        "version": "1.0.0",
        "onSurveyShowed": {(e:Any) -> () in print("Screeb survey showed " + String(describing: e))},
    ]
)

Payload definition

{
    channel: {
        id: string,
        type: "ios"
    },
    survey: {
        id: string,
        survey_position: "center-left" | "center-center" | "center-right" | "bottom-left" | "bottom-center" | "bottom-right",
        survey_size: 25 | 50 | 75 | 100 | 125 | 150,
        survey_format: "conversational" | "cards",
    },
    response: {
        id: string,
        items: {
            question: {
                id: string;
                title: string;
                type: "text" | "video";
                url: string;
            };
            answer: {
                fields: {
                    type: "string" | "number" | "boolean" | "none" | "time" | "url";
                },
                text: string;
                number: number;
                boolean: boolean;
                time: Date;
                url: string;
            }[] | undefined;
            replied_at: Date | undefined;
        }[];
    },
    user: {
        anonymous_id: string,
        user_id: string,
    }
}

`onSurveyStarted`

Called when a survey is started.

Example

Screeb.initSdk(
    context: nil,
    channelId: "<YOUR-CHANNEL-ID>",
    hooks: [
        "version": "1.0.0",
        "onSurveyStarted": {(e:Any) -> () in print("Screeb survey started " + String(describing: e))},
    ]
)

Payload definition

{
    channel: {
        id: string,
        type: "ios"
    },
    survey: {
        id: string,
        survey_position: "center-left" | "center-center" | "center-right" | "bottom-left" | "bottom-center" | "bottom-right",
        survey_size: 25 | 50 | 75 | 100 | 125 | 150,
        survey_format: "conversational" | "cards",
    },
    response: {
        id: string,
    },
    user: {
        anonymous_id: string,
        user_id: string,
    }
}

`onQuestionReplied`

Called when a question is replied.

Example

Screeb.initSdk(
    context: nil,
    channelId: "<YOUR-CHANNEL-ID>",
    hooks: [
        "version": "1.0.0",
        "onQuestionReplied": {(e:Any) -> () in print("Screeb Question Replied " + String(describing: e))},
    ]
)

Payload definition

{
    channel: {
        id: string,
        type: "ios"
    },
    survey: {
        id: string,
        survey_position: "center-left" | "center-center" | "center-right" | "bottom-left" | "bottom-center" | "bottom-right",
        survey_size: 25 | 50 | 75 | 100 | 125 | 150,
        survey_format: "conversational" | "cards",
    },
    response: {
        id: string,
        status: "started" | "ended" | "closed" | "interrupted"
        question: {
            id: string;
            title: string;
            type: "text" | "video";
            url: string;
        };
        answer: {
            fields: {
                type: "string" | "number" | "boolean" | "none" | "time" | "url";
            },
            text: string;
            number: number;
            boolean: boolean;
            time: Date;
            url: string;
        };
        items: {
            question: {
                id: string;
                title: string;
                type: "text" | "video";
                url: string;
            };
            answer: {
                fields: {
                    type: "string" | "number" | "boolean" | "none" | "time" | "url";
                },
                text: string;
                number: number;
                boolean: boolean;
                time: Date;
                url: string;
            }[] | undefined;
            replied_at: Date | undefined;
        }[];
    },
    user: {
        anonymous_id: string,
        user_id: string,
    }
}

`onSurveyCompleted`

Called when a survey is completed.

Example

Screeb.initSdk(
    context: nil,
    channelId: "<YOUR-CHANNEL-ID>",
    hooks: [
        "version": "1.0.0",
        "onSurveyCompleted": {(e:Any) -> () in print("Screeb survey completed " + String(describing: e))},
    ]
)

Payload definition

{
    channel: {
        id: string,
        type: "ios"
    },
    survey: {
        id: string,
        survey_position: "center-left" | "center-center" | "center-right" | "bottom-left" | "bottom-center" | "bottom-right",
        survey_size: 25 | 50 | 75 | 100 | 125 | 150,
        survey_format: "conversational" | "cards",
    },
    response: {
        id: string,
        items: {
            question: {
                id: string;
                title: string;
                type: "text" | "video";
                url: string;
            };
            answer: {
                fields: {
                    type: "string" | "number" | "boolean" | "none" | "time" | "url";
                },
                text: string;
                number: number;
                boolean: boolean;
                time: Date;
                url: string;
            }[] | undefined;
            replied_at: Date | undefined;
        }[];
    },
    user: {
        anonymous_id: string,
        user_id: string,
    }
}

`onSurveyHidden`

Called when a survey is hidden.

Example

Screeb.initSdk(
    context: nil,
    channelId: "<YOUR-CHANNEL-ID>",
    hooks: [
        "version": "1.0.0",
        "onSurveyHidden": {(e:Any) -> () in print("Screeb survey hidden " + String(describing: e))},
    ]
)

Payload definition

{
    channel: {
        id: string,
        type: "ios"
    },
    survey: {
        id: string,
        survey_position: "center-left" | "center-center" | "center-right" | "bottom-left" | "bottom-center" | "bottom-right",
        survey_size: 25 | 50 | 75 | 100 | 125 | 150,
        survey_format: "conversational" | "cards",
    },
    response: {
        id: string,
        hide_reason: "started" | "ended" | "closed" | "interrupted",
        items: {
            question: {
                id: string;
                title: string;
                type: "text" | "video";
                url: string;
            };
            answer: {
                fields: {
                    type: "string" | "number" | "boolean" | "none" | "time" | "url";
                },
                text: string;
                number: number;
                boolean: boolean;
                time: Date;
                url: string;
            }[] | undefined;
            replied_at: Date | undefined;
        }[];
    },
    user: {
        anonymous_id: string,
        user_id: string,
    }
}

`onAppStoreRatingTriggered`

Called when an App Store Rating question is triggered.

Example

Screeb.initSdk(
    context: nil,
    channelId: "<YOUR-CHANNEL-ID>",
    hooks: [
        "version": "1.0.0",
        "onAppStoreRatingTriggered": {(e:Any) -> () in print("Screeb app store rating triggered " + String(describing: e))},
    ]
)

Payload definition

{
    channel: {
        id: string,
        type: "ios"
    },
    user: {
        anonymous_id: string,
        user_id: string,
    }
}

`onReady`

Called when the SDK is ready. Only available on Screeb.initSdk().

Example

Screeb.initSdk(
    context: nil,
    channelId: "<YOUR-CHANNEL-ID>",
    hooks: [
        "version": "1.0.0",
        "onReady": {(e:Any) -> () in print("Screeb SDK ready " + String(describing: e))},
    ]
)

Payload definition

{
    channel: {
        id: string,
        type: "ios"
    },
    user: {
        anonymous_id: string,
        user_id: string,
    }
}

`onSurveyDisplayAllowed`

Called before a survey display to allow it or not. Only available on Screeb.initSdk(). Return a boolean value. Return false to prevent display.

caution

The answer must arrive within 5 seconds. Past that deadline the display evaluation fails and the survey is not shown — keep this callback fast and avoid slow network calls; when unsure, return true early.

Example

Screeb.initSdk(
    context: nil,
    channelId: "<YOUR-CHANNEL-ID>",
    hooks: [
        "version": "1.0.0",
        "onSurveyDisplayAllowed": {(e:Any) -> Bool in print("Screeb survey display available " + String(describing: e)); return true},
    ]
)

Payload definition

{
    channel: {
        id: string,
        type: "ios"
    },
    survey: {
        id: string,
    },
    user: {
        anonymous_id: string,
        user_id: string,
    }
}

`onMessageShowed`

Called when a message is showed.

Example

Screeb.initSdk(
    context: nil,
    channelId: "<YOUR-CHANNEL-ID>",
    hooks: [
        "version": "1.0.0",
        "onMessageShowed": {(e:Any) -> () in print("Screeb message showed " + String(describing: e))},
    ]
)

Payload definition

{
    channel: {
        id: string,
        type: "ios"
    },
    message: {
        message_size: 25 | 50 | 75 | 100 | 125 | 150,
        id: string | null,
    },
    response: {
        id: string,
        items: {
            question: {
                id: string;
                title: string;
                type: "text" | "video";
                url: string;
            };
            answer: {
                fields: {
                    type: "string" | "number" | "boolean" | "none" | "time" | "url";
                },
                text: string;
                number: number;
                boolean: boolean;
                time: Date;
                url: string;
            }[] | undefined;
            replied_at: Date | undefined;
        }[];
    },
    user: {
        anonymous_id: string,
        user_id: string,
    }
}

`onMessageStarted`

Called when a message is started.

Example

Screeb.initSdk(
    context: nil,
    channelId: "<YOUR-CHANNEL-ID>",
    hooks: [
        "version": "1.0.0",
        "onMessageStarted": {(e:Any) -> () in print("Screeb message showed " + String(describing: e))},
    ]
)

Payload definition

{
    channel: {
        id: string,
        type: "ios"
    },
    message: {
        message_size: 25 | 50 | 75 | 100 | 125 | 150,
        id: string | null,
    },
    response: {
        id: string,
    },
    user: {
        anonymous_id: string,
        user_id: string,
    }
}

`onMessageCompleted`

Called when a message is completed.

Example

Screeb.initSdk(
    context: nil,
    channelId: "<YOUR-CHANNEL-ID>",
    hooks: [
        "version": "1.0.0",
        "onMessageCompleted": {(e:Any) -> () in print("Screeb message showed " + String(describing: e))},
    ]
)

Payload definition

{
    channel: {
        id: string,
        type: "ios"
    },
    message: {
        message_size: 25 | 50 | 75 | 100 | 125 | 150,
        id: string | null,
    },
    response: {
        id: string,
        items: {
            question: {
                id: string;
                title: string;
                type: "text" | "video";
                url: string;
            };
            answer: {
                fields: {
                    type: "string" | "number" | "boolean" | "none" | "time" | "url";
                },
                text: string;
                number: number;
                boolean: boolean;
                time: Date;
                url: string;
            }[] | undefined;
            replied_at: Date | undefined;
        }[];
    },
    user: {
        anonymous_id: string,
        user_id: string,
    }
}

`onMessageHidden`

Called when a message is hidden.

Example

Screeb.initSdk(
    context: nil,
    channelId: "<YOUR-CHANNEL-ID>",
    hooks: [
        "version": "1.0.0",
        "onMessageHidden": {(e:Any) -> () in print("Screeb message showed " + String(describing: e))},
    ]
)

Payload definition

{
    channel: {
        id: string,
        type: "ios"
    },
    message: {
        message_size: 25 | 50 | 75 | 100 | 125 | 150,
        id: string | null,
    },
    response: {
        id: string,
        hide_reason: "started" | "ended" | "closed" | "interrupted",
        items: {
            question: {
                id: string;
                title: string;
                type: "text" | "video";
                url: string;
            };
            answer: {
                fields: {
                    type: "string" | "number" | "boolean" | "none" | "time" | "url";
                },
                text: string;
                number: number;
                boolean: boolean;
                time: Date;
                url: string;
            }[] | undefined;
            replied_at: Date | undefined;
        }[];
    },
    user: {
        anonymous_id: string,
        user_id: string,
    }
}

`onMessageDisplayAllowed`

Called before a message display to allow it or not. Only available on initSdk(). Return a boolean value. Return false to prevent display.

caution

The answer must arrive within 5 seconds. Past that deadline the display evaluation fails and the message is not shown — keep this callback fast and avoid slow network calls; when unsure, return true early.

Example

Screeb.initSdk(
    context: nil,
    channelId: "<YOUR-CHANNEL-ID>",
    hooks: [
        "version": "1.0.0",
        "onMessageDisplayAllowed": {(e:Any) -> Bool in print("Screeb message display available " + String(describing: e)); return true},
    ]
)

Payload definition

{
    channel: {
        id: string,
        type: "ios"
    },
    message: {
        id: string,
    },
    user: {
        anonymous_id: string,
        user_id: string,
    }
}

Set hooks​

Available hooks​

Set hooks on SDK init​

Set hooks on survey start​

Set hooks on message start​

onSurveyShowed​

onSurveyStarted​

onQuestionReplied​

onSurveyCompleted​

onSurveyHidden​

onAppStoreRatingTriggered​

onReady​

onSurveyDisplayAllowed​

onMessageShowed​

onMessageStarted​

onMessageCompleted​

onMessageHidden​

onMessageDisplayAllowed​

Set hooks

Available hooks

Set hooks on SDK init

Set hooks on survey start

Set hooks on message start

`onSurveyShowed`

`onSurveyStarted`

`onQuestionReplied`

`onSurveyCompleted`

`onSurveyHidden`

`onAppStoreRatingTriggered`

`onReady`

`onSurveyDisplayAllowed`

`onMessageShowed`

`onMessageStarted`

`onMessageCompleted`

`onMessageHidden`

`onMessageDisplayAllowed`